diff --git a/.github/workflows/blackbox-testing.yml b/.github/workflows/blackbox-testing.yml deleted file mode 100644 index 807ba92da0..0000000000 --- a/.github/workflows/blackbox-testing.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Blackbox testing (Stay Awhile and Listen) -on: - push: - pull_request: - types: [opened, reopened, synchronize, ready_for_review] -jobs: - test: - name: BlackBox testing ${{ matrix.os }} - if: "github.event.pull_request.draft == false &&!((github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'ci: update global workflows')) || (github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'chore(release):')) || (github.actor == 'allcontributors' && startsWith(github.event.pull_request.title, 'docs: add')))" - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest] - steps: - - name: Checkout repository - uses: actions/checkout@v3 - - name: Check package-lock version - uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master - id: lockversion - - name: Setup Node.js - uses: actions/setup-node@v3 - with: - node-version: "${{ steps.lockversion.outputs.version }}" - cache: 'npm' - cache-dependency-path: '**/package-lock.json' - - name: Build library - run: npm install && npm run build - - uses: actions/setup-java@v2 - with: - distribution: 'adopt' - java-version: '11' - - if: matrix.os != 'windows-latest' - name: Setup dotnet - uses: actions/setup-dotnet@v1 - with: - dotnet-version: '5.0.x' - - if: matrix.os == 'windows-latest' - name: Setup csc.exe - uses: yoavain/Setup-CSC@v7 - - uses: actions/setup-go@v2 - with: - go-version: '1.16.8' - - name: Test output - run: npm run test:blackbox \ No newline at end of file diff --git a/README.md b/README.md index 01400f49e0..6e8d4cbe28 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ [![AsyncAPI Modelina](./docs/img/readme-banner.png)](https://www.modelina.org) -[![blackbox pipeline status]()](https://github.com/asyncapi/modelina/actions/workflows/blackbox-testing.yml?query=branch%3Amaster++) [![Coverage Status](https://coveralls.io/repos/github/asyncapi/modelina/badge.svg?branch=master)](https://coveralls.io/github/asyncapi/modelina?branch=master) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) ![Maintenance score](https://img.shields.io/npms-io/maintenance-score/@asyncapi/modelina) diff --git a/docs/contributing.md b/docs/contributing.md index 5e944abc7c..c08be95cdd 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -132,7 +132,6 @@ Time to adapt the tests, cause without tests, it's just an empty promise. The te 4. Adapt the [generator tests](../test/generators/template/TemplateGenerator.spec.ts) 5. Adapt the [renderer tests](../test/generators/template/TemplateRenderer.spec.ts) 6. Add your generator to the [FileGenerators test](../test/generators/FileGenerators.spec.ts) to ensure the models are accurately written to files. -7. Lastly, we have (arguably) the most important tests, [the BlackBox tests](./development.md#blackbox-testing). They are to ensure that real-world inputs generate usable models that do not contain syntax errors. You can read more about the BlackBox tests [here](./development.md#blackbox-testing). Lastly, we need to adapt some of the docs to showcase your new awesome generator! Cause if the users cant find it, it dont exist. 1. Add your [generator specific documentation under languages](./languages/) and add it to the [list of generators](./README.md#languages) @@ -163,7 +162,6 @@ That said, here is a general rundown on what's triggered by each PR: - We inherit all [AsyncAPI core GitHub workflows](https://github.com/asyncapi/.github/tree/master/.github/workflows), including the most important one: - [A standard PR workflow](https://github.com/asyncapi/.github/blob/master/.github/workflows/if-nodejs-pr-testing.yml) which ensures that the following commands need to succeed: `npm run test`, `npm run lint`, and `npm run generate:assets`. -- [BlackBox testing](https://github.com/asyncapi/modelina/tree/master/test/blackbox) has its [own workflow](https://github.com/asyncapi/modelina/blob/master/.github/workflows/blackbox-testing.yml) which ensures that all supported inputs generate syntactically correct outputs to any of the output languages. This check takes a while (usually +5 minutes). Generally, you don't need to worry about this one, unless the code were to suddenly generate syntactically incorrect code (we will guide you if this happens). - [Coverall](https://github.com/asyncapi/modelina/blob/master/.github/workflows/coverall.yml) ensures we get test coverage statistics in each PR, thus ensuring we see how it affects overall test coverage. It creates a comment on the PR with the coverage status. - [SonarCloud](https://sonarcloud.io/dashboard?id=asyncapi_generator-model-sdk) runs a code analysis to ensure no bugs, security concerns, code smells, or duplicated code blocks. Make sure you address any concerns found by this bot, because it generates a comment to the PR if it finds any issue. diff --git a/docs/development.md b/docs/development.md index 62db7265c8..e4894c23fd 100644 --- a/docs/development.md +++ b/docs/development.md @@ -9,7 +9,6 @@ You can either build the image and run the needed commands manually or rather us - `npm run docker:build` builds the docker image with the tag `asyncapi/modelina` (the rest of the scripts run this one as well). - `npm run docker:test` runs the main test suite. -- `npm run docker:test:blackbox` runs the BlackBox test suite. ## Environment setup @@ -21,6 +20,3 @@ To setup the environment follow these steps: - You can update snapshots by running `npm run test -- -u` 4. Make sure code is well formatted and secure with eslint by running `npm run lint`, you can also auto format your code with `npm run format` -## BlackBox testing - -We have several BlackBox tests that are run separately from the `npm run test` script. Please refer to the [BlackBox documentation](../test/blackbox) for further information. diff --git a/package.json b/package.json index 2a97992c52..265fd92b48 100644 --- a/package.json +++ b/package.json @@ -79,11 +79,10 @@ "build:cli": "npm pack --pack-destination modelina-cli && node modelina-cli/scripts/renameModelinaPack.js && cd modelina-cli && npm i && npm run build", "docker:build": "docker compose run --build modelina npm install", "docker:test": "docker compose run modelina npm run test", - "docker:test:blackbox": "docker compose run modelina npm run test:blackbox", "test": "npm run test:library && npm run test:examples && npm run test:cli", "test:cli": "cd modelina-cli && npm run test", "test:update": "npm run test:library -- -u && npm run test:examples:update", - "test:library": "cross-env CI=true jest --coverage --testPathIgnorePatterns ./test/blackbox --testPathIgnorePatterns ./modelina-website --testPathIgnorePatterns ./test/runtime --testPathIgnorePatterns ./examples", + "test:library": "cross-env CI=true jest --coverage --testPathIgnorePatterns ./modelina-website --testPathIgnorePatterns ./test/runtime --testPathIgnorePatterns ./examples", "test:examples": "npm run test:examples:regular && npm run test:examples:websites", "test:examples:update": "npm run test:examples:regular -- -u && npm run test:examples:websites -- -u", "test:examples:regular": "cross-env CI=true jest ./examples --testPathIgnorePatterns ./examples/integrate-with-react --testPathIgnorePatterns ./examples/integrate-with-next", @@ -91,17 +90,6 @@ "test:examples:websites:update": "npm run test:examples:react -- -u && npm run test:examples:next -- -u", "test:examples:react": "cd ./examples/integrate-with-react && npm i && npm run test", "test:examples:next": "cd ./examples/integrate-with-next && npm i && npm run test", - "test:blackbox": "concurrently --group -n csharp,go,java,javascript,php,python,rust,typescript,kotlin,cplusplus \"npm run test:blackbox:csharp\" \"npm run test:blackbox:go\" \"npm run test:blackbox:java\" \"npm run test:blackbox:javascript\" \"npm run test:blackbox:php\" \"npm run test:blackbox:python\" \"npm run test:blackbox:rust\" \"npm run test:blackbox:typescript\" \"npm run test:blackbox:kotlin\" \"npm run test:blackbox:cplusplus\"", - "test:blackbox:csharp": "cross-env CI=true jest ./test/blackbox/blackbox-csharp.spec.ts", - "test:blackbox:go": "cross-env CI=true jest ./test/blackbox/blackbox-go.spec.ts", - "test:blackbox:javascript": "cross-env CI=true jest ./test/blackbox/blackbox-javascript.spec.ts", - "test:blackbox:php": "cross-env CI=true jest ./test/blackbox/blackbox-php.spec.ts", - "test:blackbox:python": "cross-env CI=true jest ./test/blackbox/blackbox-python.spec.ts", - "test:blackbox:rust": "cross-env CI=true jest ./test/blackbox/blackbox-rust.spec.ts", - "test:blackbox:typescript": "cross-env CI=true jest ./test/blackbox/blackbox-typescript.spec.ts", - "test:blackbox:kotlin": "cross-env CI=true jest ./test/blackbox/blackbox-kotlin.spec.ts", - "test:blackbox:cplusplus": "cross-env CI=true jest ./test/blackbox/blackbox-cplusplus.spec.ts", - "test:blackbox:java": "cross-env CI=true jest ./test/blackbox/blackbox-java.spec.ts", "test:runtime:java": "cross-env CI=true jest ./test/runtime/runtime-java.spec.ts", "test:runtime:python": "cross-env CI=true jest ./test/runtime/runtime-python.spec.ts", "generate:runtime:python": "cross-env CI=true ts-node ./test/runtime/runtime-python.ts", diff --git a/src/helpers/FileHelpers.ts b/src/helpers/FileHelpers.ts index 981c2f5ce7..0a70555759 100644 --- a/src/helpers/FileHelpers.ts +++ b/src/helpers/FileHelpers.ts @@ -37,7 +37,7 @@ export class FileHelpers { /** * It happens that the promise is resolved before the file is actually written to. * - * This often happen if the file system is swamped with write requests in either benchmarks or in our blackbox tests. + * This often happen if the file system is swamped with write requests in either benchmarks * * To avoid this we dont resolve until we are sure the file is written and exists. */ diff --git a/test/TestUtils/GeneralUtils.ts b/test/TestUtils/GeneralUtils.ts new file mode 100644 index 0000000000..62cc10fd58 --- /dev/null +++ b/test/TestUtils/GeneralUtils.ts @@ -0,0 +1,28 @@ +/* eslint-disable no-undef */ +import { promisify } from 'util'; +import { exec } from 'child_process'; +const promiseExec = promisify(exec); + +/** + * Execute a command and if any errors occur reject the promise. + * + * @param command + */ +export async function execCommand( + command: string, + allowStdError = false +): Promise { + try { + const { stderr } = await promiseExec(command); + if (stderr !== '') { + if (!allowStdError) { + return Promise.reject(stderr); + } + // eslint-disable-next-line no-console + console.error(stderr); + } + return Promise.resolve(); + } catch (e: any) { + return Promise.reject(`${e.stack}; Stdout: ${e.stdout}`); + } +} diff --git a/test/blackbox/.gitignore b/test/blackbox/.gitignore deleted file mode 100644 index 6caf68aff4..0000000000 --- a/test/blackbox/.gitignore +++ /dev/null @@ -1 +0,0 @@ -output \ No newline at end of file diff --git a/test/blackbox/BlackBoxTestFiles.ts b/test/blackbox/BlackBoxTestFiles.ts deleted file mode 100644 index 03453a28af..0000000000 --- a/test/blackbox/BlackBoxTestFiles.ts +++ /dev/null @@ -1,86 +0,0 @@ -import * as path from 'path'; -import * as fs from 'fs'; - -/** - * Read all the files in the folder, and return the appropriate Jest `each` entries. - * @param folder - */ -function readFilesInFolder(folder: string) { - // eslint-disable-next-line no-undef - const fullPath = path.resolve(__dirname, `./docs/${folder}`); - // eslint-disable-next-line security/detect-non-literal-fs-filename - return fs.readdirSync(fullPath).map((file) => { - return { - file: `./docs/${folder}/${file}`, - outputDirectory: `./output/${folder}/${path.parse(file).name}` - }; - }); -} - -const Swagger2Files = readFilesInFolder('Swagger-2_0'); -const OpenAPI3_0Files = readFilesInFolder('OpenAPI-3_0'); -const jsonSchemaDraft7Files = readFilesInFolder('JsonSchemaDraft-7'); -const jsonSchemaDraft6Files = readFilesInFolder('JsonSchemaDraft-6'); -const jsonSchemaDraft4Files = readFilesInFolder('JsonSchemaDraft-4'); -const AsyncAPIV2_0Files = readFilesInFolder('AsyncAPI-2_0'); -const AsyncAPIV2_1Files = readFilesInFolder('AsyncAPI-2_1'); -const AsyncAPIV2_2Files = readFilesInFolder('AsyncAPI-2_2'); -const AsyncAPIV2_3Files = readFilesInFolder('AsyncAPI-2_3'); -const AsyncAPIV2_4Files = readFilesInFolder('AsyncAPI-2_4'); -const AsyncAPIV2_5Files = readFilesInFolder('AsyncAPI-2_5'); -const AsyncAPIV2_6Files = readFilesInFolder('AsyncAPI-2_6'); - -const filesToTest = [ - ...Swagger2Files, - ...OpenAPI3_0Files.filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('postman-api.json'); - }).filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('twilio-1_13.json'); - }), - ...AsyncAPIV2_0Files.filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('zbos_mqtt-all-asyncapi.json'); - }), - ...AsyncAPIV2_1Files, - ...AsyncAPIV2_2Files, - ...AsyncAPIV2_3Files, - ...AsyncAPIV2_4Files, - ...AsyncAPIV2_5Files, - ...AsyncAPIV2_6Files, - ...jsonSchemaDraft4Files.filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('aws-cloudformation.json'); - }), - ...jsonSchemaDraft7Files.filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('graphql-code-generator.json'); - }), - ...jsonSchemaDraft6Files.filter(({ file }) => { - // Too large to process in normal blackbox testing, can be used to locally test stuff. - return !file.includes('fhir-full.json'); - }) -]; - -/** - * Officially only use one specific file for each input type, and the rest is for local testing. - * - * Otherwise the CI system will take far too long. - */ -export default filesToTest.filter(({ file }) => { - return ( - file.includes('AsyncAPI-2_0/dummy.json') || - file.includes('AsyncAPI-2_1/dummy.json') || - file.includes('AsyncAPI-2_2/dummy.json') || - file.includes('AsyncAPI-2_3/dummy.json') || - file.includes('AsyncAPI-2_4/dummy.json') || - file.includes('AsyncAPI-2_5/streetlight_kafka.json') || - file.includes('AsyncAPI-2_6/dummy.json') || - file.includes('JsonSchemaDraft-4/draft-4-core.json') || - file.includes('JsonSchemaDraft-6/draft-6-core.json') || - file.includes('JsonSchemaDraft-7/draft-7-core.json') || - file.includes('OpenAPI-3_0/petstore.json') || - file.includes('Swagger-2_0/petstore.json') - ); -}); diff --git a/test/blackbox/README.md b/test/blackbox/README.md deleted file mode 100644 index 51b5742681..0000000000 --- a/test/blackbox/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# BlackBox tests - -As we start to integrate more and more inputs, we must test actual and real inputs from users to ensure the library behaves as expected. For now, the best way is to add them as BlackBox tests. The BlackBox tests are focused on catching syntax errors and not logical errors, although they can be manually used for this. - -The documents being tested can be found under [docs](./docs), which contain documents for the following input types: -- [AsyncAPI 2.0](./docs/AsyncAPI-2_0) -- [AsyncAPI 2.1](./docs/AsyncAPI-2_1) -- [AsyncAPI 2.2](./docs/AsyncAPI-2_2) -- [AsyncAPI 2.3](./docs/AsyncAPI-2_3) -- [AsyncAPI 2.4](./docs/AsyncAPI-2_4) -- [AsyncAPI 2.5](./docs/AsyncAPI-2_5) -- [AsyncAPI 2.6](./docs/AsyncAPI-2_6) -- [JSON Schema draft 4](./docs/JsonSchemaDraft-4) -- [JSON Schema draft 6](./docs/JsonSchemaDraft-6) -- [JSON Schema draft 7](./docs/JsonSchemaDraft-7) -- [Swagger 2.0](./docs/Swagger-2_0) -- [OpenAPI 3.0](./docs/OpenAPI-3_0) - -Each document is tested across all output languages and output will be written to `./output` folder in appropriate sub-folders, for easier access. - -## Running the tests -The tests can either be run by installing all dependencies locally or running it through docker. - -If you want to run the BlackBox tests locally, you have to install a couple of dependencies: -- To run the `Java` BlackBox tests, you need to have JDK installed. -- To run the `TypeScript` BlackBox tests, you need to have TypeScript installed globally - `npm install -g typescript`. -- To run the `C#` BlackBox tests, you need to have C# compiler installed globally. - https://www.mono-project.com/download/stable/ -- To run the `Go` BlackBox tests, you need to have GoLang installed - https://golang.org/doc/install -- To run the `Python` BlackBox tests, you need to have python installed - https://www.python.org/downloads/ -- To run the `PHP` BlackBox tests, you need to have PHP installed - https://www.php.net/downloads.php/ -- To run the `Rust` BlackBox tests, you need to have rust installed - https://www.rust-lang.org/tools/install (if you are on mac you might also need to install xcode `xcode-select --install`) -- To run the `Kotlin` BlackBox tests, you need to have a JDK >= 8 as well as kotlinc installed - https://kotlinlang.org/docs/command-line.html -- To run the `C++` BlackBox tests, you need to have a GNU C++ compiler installed - https://gcc.gnu.org/install/ - -By default, the BlackBox tests are not run with the regular `npm run test`, but can be run with `npm run test:blackbox`. Or run individual BlackBox tests you can run the commands `npm run test:blackbox:${language}` where language is one of `csharp`, `go`, `java`, `javascript`, `python`, `php`, `rust`, `typescript`, etc. - -To run the BlackBox tests through Docker, run the command `npm run docker:test:blackbox`. diff --git a/test/blackbox/blackbox-cplusplus.spec.ts b/test/blackbox/blackbox-cplusplus.spec.ts deleted file mode 100644 index 12d8ec2ec3..0000000000 --- a/test/blackbox/blackbox-cplusplus.spec.ts +++ /dev/null @@ -1,62 +0,0 @@ -/** - * Blackbox tests are the final line of defence, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ -import * as path from 'path'; -import * as fs from 'fs'; -import { - CplusplusFileGenerator, - InputMetaModel, - InputProcessor -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -/** - * The C++ generator does not support recursive objects that many examples showcase. - */ -const nonRecursiveFilesToTest = filesToTest.filter(({ file }) => { - return ( - file.includes('OpenAPI-3_0/petstore.json') || - file.includes('AsyncAPI-2_5/streetlight_kafka.json') || - file.includes('AsyncAPI-2_6/dummy.json') || - file.includes('Swagger-2_0/petstore.json') - ); -}); - -describe.each(nonRecursiveFilesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve(__dirname, outputDirectory, 'cpp'); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - test('should be able to generate and compile C++ models', async () => { - const generator = new CplusplusFileGenerator(); - const renderOutputPath = path.resolve(outputDirectoryPath, './class'); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - { namespace: 'TestNamespace' } - ); - expect(generatedModels).not.toHaveLength(0); - - const transpileCommand = `cd ${renderOutputPath} && g++ -std=c++17 *.hpp -fsyntax-only -I ./`; - await execCommand(transpileCommand); - }); - }); - } -); diff --git a/test/blackbox/blackbox-csharp.spec.ts b/test/blackbox/blackbox-csharp.spec.ts deleted file mode 100644 index f59e0ab291..0000000000 --- a/test/blackbox/blackbox-csharp.spec.ts +++ /dev/null @@ -1,54 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { CSharpFileGenerator, InputMetaModel } from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve( - __dirname, - outputDirectory, - 'csharp' - ); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const generator = new CSharpFileGenerator(); - const input = JSON.parse(String(inputFileContent)); - models = await generator.process(input); - }); - describe(file, () => { - describe('should be able to generate and compile C#', () => { - test('class and enums', async () => { - const generator = new CSharpFileGenerator(); - - const generatedModels = await generator.generateToFiles( - models, - outputDirectoryPath, - { namespace: 'TestNamespace' } - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `csc /target:library /out:${path.resolve( - outputDirectoryPath, - './compiled.dll' - )} ${path.resolve(outputDirectoryPath, '*.cs')}`; - await execCommand(compileCommand); - }); - }); - }); - } -); diff --git a/test/blackbox/blackbox-go.spec.ts b/test/blackbox/blackbox-go.spec.ts deleted file mode 100644 index da2b8a65ab..0000000000 --- a/test/blackbox/blackbox-go.spec.ts +++ /dev/null @@ -1,52 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { GoFileGenerator, InputMetaModel, InputProcessor } from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve(__dirname, outputDirectory, 'go'); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - describe('should be able to generate Go', () => { - test('struct', async () => { - const generator = new GoFileGenerator(); - const renderOutputPath = path.resolve( - outputDirectoryPath, - './struct/' - ); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - { packageName: 'test_package_name' } - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `gofmt ${renderOutputPath}`; - await execCommand(compileCommand); - }); - }); - }); - } -); diff --git a/test/blackbox/blackbox-java.spec.ts b/test/blackbox/blackbox-java.spec.ts deleted file mode 100644 index 7028744eca..0000000000 --- a/test/blackbox/blackbox-java.spec.ts +++ /dev/null @@ -1,84 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - JavaFileGenerator, - JAVA_COMMON_PRESET -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve( - __dirname, - outputDirectory, - 'java' - ); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - const javaGeneratorOptions = [ - { - generatorOption: {}, - description: 'default generator', - renderOutputPath: path.resolve(outputDirectoryPath, './class/default') - }, - { - generatorOption: { - presets: [JAVA_COMMON_PRESET] - }, - description: 'all common presets', - renderOutputPath: path.resolve( - outputDirectoryPath, - './class/commonpreset' - ) - } - ]; - describe.each(javaGeneratorOptions)( - 'should be able to generate and compile Java', - ({ generatorOption, renderOutputPath, description }) => { - test(`class and enums ${description}`, async () => { - const generator = new JavaFileGenerator(generatorOption); - const dependencyPath = path.resolve( - __dirname, - './dependencies/java/*' - ); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - { packageName: 'TestPackageName' } - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `javac -cp ${dependencyPath} ${path.resolve( - renderOutputPath, - '*.java' - )}`; - await execCommand(compileCommand); - }); - } - ); - }); - } -); diff --git a/test/blackbox/blackbox-javascript.spec.ts b/test/blackbox/blackbox-javascript.spec.ts deleted file mode 100644 index 8618eff2ef..0000000000 --- a/test/blackbox/blackbox-javascript.spec.ts +++ /dev/null @@ -1,62 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - JavaScriptFileGenerator -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve(__dirname, outputDirectory, 'js'); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - describe('should be able to generate JS', () => { - test('class', async () => { - const generator = new JavaScriptFileGenerator({ - moduleSystem: 'CJS' - }); - const renderOutputPath = path.resolve(outputDirectoryPath, './class'); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - {}, - true - ); - expect(generatedModels).not.toHaveLength(0); - - const files = fs.readdirSync(renderOutputPath); - for (const file of files) { - const transpileAndRunCommand = `node --check ${path.resolve( - renderOutputPath, - file - )}`; - await execCommand(transpileAndRunCommand); - } - }); - }); - }); - } -); diff --git a/test/blackbox/blackbox-kotlin.spec.ts b/test/blackbox/blackbox-kotlin.spec.ts deleted file mode 100644 index d2b5004cbc..0000000000 --- a/test/blackbox/blackbox-kotlin.spec.ts +++ /dev/null @@ -1,101 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - KotlinFileGenerator, - KOTLIN_CONSTRAINTS_PRESET -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -async function generate(fileToGenerateFor: string): Promise { - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - return processor.process(input); -} - -function deleteDirectoryIfExists(directory: string) { - if (fs.existsSync(directory)) { - fs.rmSync(directory, { recursive: true }); - } -} - -const isWindows = process.platform === 'win32'; -const describeIf = (condition: boolean) => - condition ? describe : describe.skip; - -// Windows environment has a weird setup, where it is using Kotlin Native instead of Kotlin JVM as it's compiler -// (See https://github.com/asyncapi/modelina/issues/1080) -describeIf(!isWindows).each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve( - __dirname, - outputDirectory, - 'kotlin' - ); - - let models: InputMetaModel; - beforeAll(async () => { - deleteDirectoryIfExists(outputDirectoryPath); - models = await generate(fileToGenerateFor); - }); - - describe(file, () => { - const kotlinGeneratorOptions = [ - { - generatorOption: {}, - description: 'default generator', - renderOutputPath: path.resolve(outputDirectoryPath, './class/default') - }, - { - generatorOption: { - presets: [KOTLIN_CONSTRAINTS_PRESET] - }, - description: 'constraints preset', - renderOutputPath: path.resolve( - outputDirectoryPath, - './class/constraints' - ) - } - ]; - - describe.each(kotlinGeneratorOptions)( - 'should be able to generate and compile Kotlin', - ({ generatorOption, renderOutputPath, description }) => { - test(`class and enums ${description}`, async () => { - const generator = new KotlinFileGenerator(generatorOption); - const dependencyPath = path.resolve( - __dirname, - './dependencies/kotlin/*' - ); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - { packageName: 'main' } - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `kotlinc ${path.resolve( - renderOutputPath, - '*.kt' - )} -cp ${dependencyPath} -d ${renderOutputPath}`; - await execCommand(compileCommand); - }); - } - ); - }); - } -); diff --git a/test/blackbox/blackbox-php.spec.ts b/test/blackbox/blackbox-php.spec.ts deleted file mode 100644 index 2931c8c9ed..0000000000 --- a/test/blackbox/blackbox-php.spec.ts +++ /dev/null @@ -1,79 +0,0 @@ -/** - * Blackbox tests are the final line of defence, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - OutputModel, - PHP_DEFAULT_PRESET, - PhpFileGenerator -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve(__dirname, outputDirectory, 'php'); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - const phpGeneratorOptions = [ - { - generatorOption: {}, - description: 'default generator', - renderOutputPath: path.resolve(outputDirectoryPath, './class/default') - }, - { - generatorOption: { - presets: [PHP_DEFAULT_PRESET] - }, - description: 'all common presets', - renderOutputPath: path.resolve( - outputDirectoryPath, - './class/commonpreset' - ) - } - ]; - describe.each(phpGeneratorOptions)( - 'should be able to generate and compile PHP', - ({ generatorOption, renderOutputPath }) => { - test('class and enums', async () => { - const generator: PhpFileGenerator = new PhpFileGenerator( - generatorOption - ); - const generatedModels: OutputModel[] = - await generator.generateToFiles(models, renderOutputPath, { - namespace: 'TestNamespace', - declareStrictTypes: true - }); - expect(generatedModels).not.toHaveLength(0); - - const files: string[] = fs.readdirSync(renderOutputPath); - - for (const file of files) { - const filePath = path.resolve(renderOutputPath, file); - await execCommand(`php -l ${filePath}`); - } - }); - } - ); - }); - } -); diff --git a/test/blackbox/blackbox-python.spec.ts b/test/blackbox/blackbox-python.spec.ts deleted file mode 100644 index bd559d05a1..0000000000 --- a/test/blackbox/blackbox-python.spec.ts +++ /dev/null @@ -1,62 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - PythonFileGenerator, - PythonRenderCompleteModelOptions -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve( - __dirname, - outputDirectory, - 'python' - ); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - describe('should be able to generate Python', () => { - test('class and enums', async () => { - const generator = new PythonFileGenerator(); - const renderOutputPath = path.resolve( - outputDirectoryPath, - './class/' - ); - const options = {} as PythonRenderCompleteModelOptions; - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - options - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `python -m compileall -f ${renderOutputPath}`; - await execCommand(compileCommand); - expect(generatedModels).not.toHaveLength(0); - }); - }); - }); - } -); diff --git a/test/blackbox/blackbox-rust.spec.ts b/test/blackbox/blackbox-rust.spec.ts deleted file mode 100644 index 2631e1fd01..0000000000 --- a/test/blackbox/blackbox-rust.spec.ts +++ /dev/null @@ -1,87 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ - -import * as path from 'path'; -import * as fs from 'fs'; -import { - defaultRustRenderCompleteModelOptions, - InputMetaModel, - InputProcessor, - RustFileGenerator, - RustPackageFeatures, - RustRenderCompleteModelOptions -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve( - __dirname, - outputDirectory, - 'rust' - ); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - // eslint-disable-next-line jest/no-disabled-tests - describe.skip('should be able to generate Rust', () => { - test('struct with serde_json', async () => { - const generator = new RustFileGenerator(); - const renderOutputPath = path.resolve( - outputDirectoryPath, - './struct' - ); - const cargoFile = path.resolve( - outputDirectoryPath, - './struct/Cargo.toml' - ); - const options = { - ...defaultRustRenderCompleteModelOptions, - supportFiles: true, // generate Cargo.toml and lib.rs - package: { - packageName: 'asyncapi-rs-example', - packageVersion: '1.0.0', - // set authors, homepage, repository, and license - authors: ['AsyncAPI Rust Champions'], - homepage: 'https://www.asyncapi.com/tools/modelina', - repository: 'https://github.com/asyncapi/modelina', - license: 'Apache-2.0', - description: 'Rust models generated by AsyncAPI Modelina', - // support 2018 editions and up - edition: '2018', - // enable serde_json - packageFeatures: [ - RustPackageFeatures.json - ] as RustPackageFeatures[] - } - } as RustRenderCompleteModelOptions; - const generatedModels = await generator.generateToPackage( - models, - renderOutputPath, - options - ); - expect(generatedModels).not.toHaveLength(0); - - const compileCommand = `cargo build --manifest-path=${cargoFile}`; - await execCommand(compileCommand, true); - }); - }); - }); - } -); diff --git a/test/blackbox/blackbox-typescript.spec.ts b/test/blackbox/blackbox-typescript.spec.ts deleted file mode 100644 index e797dffd83..0000000000 --- a/test/blackbox/blackbox-typescript.spec.ts +++ /dev/null @@ -1,72 +0,0 @@ -/** - * Blackbox tests are the final line of defense, that takes different real-life example documents and generate their corresponding models in all supported languages. - * - * For those languages where it is possible, the models are compiled/transpiled to ensure there are no syntax errors in generated models. - * - */ -import * as path from 'path'; -import * as fs from 'fs'; -import { - InputMetaModel, - InputProcessor, - TypeScriptFileGenerator -} from '../../src'; -import { execCommand } from './utils/Utils'; -import filesToTest from './BlackBoxTestFiles'; - -describe.each(filesToTest)( - 'Should be able to generate with inputs', - ({ file, outputDirectory }) => { - jest.setTimeout(1000000); - const fileToGenerateFor = path.resolve(__dirname, file); - const outputDirectoryPath = path.resolve(__dirname, outputDirectory, 'ts'); - let models: InputMetaModel; - beforeAll(async () => { - if (fs.existsSync(outputDirectoryPath)) { - fs.rmSync(outputDirectoryPath, { recursive: true }); - } - const inputFileContent = await fs.promises.readFile(fileToGenerateFor); - const processor = new InputProcessor(); - const input = JSON.parse(String(inputFileContent)); - models = await processor.process(input); - }); - describe(file, () => { - describe('should be able to generate and transpile TS', () => { - test('class and enums', async () => { - const generator = new TypeScriptFileGenerator({ modelType: 'class' }); - const renderOutputPath = path.resolve(outputDirectoryPath, './class'); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - {} - ); - expect(generatedModels).not.toHaveLength(0); - - const transpileCommand = `tsc --downlevelIteration -t es5 --baseUrl ${renderOutputPath}`; - await execCommand(transpileCommand); - }); - - test('interface and enums', async () => { - const generator = new TypeScriptFileGenerator({ - modelType: 'interface' - }); - const renderOutputPath = path.resolve( - outputDirectoryPath, - './interface' - ); - - const generatedModels = await generator.generateToFiles( - models, - renderOutputPath, - {} - ); - expect(generatedModels).not.toHaveLength(0); - - const transpileCommand = `tsc --downlevelIteration -t es5 --baseUrl ${renderOutputPath}`; - await execCommand(transpileCommand); - }); - }); - }); - } -); diff --git a/test/blackbox/dependencies/java/jackson-annotations-2.12.3.jar b/test/blackbox/dependencies/java/jackson-annotations-2.12.3.jar deleted file mode 100644 index fd71f66d07..0000000000 Binary files a/test/blackbox/dependencies/java/jackson-annotations-2.12.3.jar and /dev/null differ diff --git a/test/blackbox/dependencies/kotlin/validation-api-2.0.1.Final.jar b/test/blackbox/dependencies/kotlin/validation-api-2.0.1.Final.jar deleted file mode 100644 index 2368e10a53..0000000000 Binary files a/test/blackbox/dependencies/kotlin/validation-api-2.0.1.Final.jar and /dev/null differ diff --git a/test/blackbox/docs/AsyncAPI-2_0/dummy.json b/test/blackbox/docs/AsyncAPI-2_0/dummy.json deleted file mode 100644 index ab7133645b..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_0/dummy.json +++ /dev/null @@ -1,568 +0,0 @@ -{ - "asyncapi": "2.0.0", - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.com" - }, - "info": { - "title": "Dummy example with all spec features included", - "version": "0.0.1", - "description": "This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.\n\nIt's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - }, - "contact": { - "name": "API Support", - "url": "http://www.asyncapi.com/support", - "email": "info@asyncapi.io" - }, - "x-twitter": "@AsyncAPISpec" - }, - "tags": [ - { - "name": "root-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag3" - }, - { - "name": "root-tag4", - "description": "Description 4" - }, - { - "name": "root-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "servers": { - "dummy-mqtt": { - "url": "mqtt://localhost", - "protocol": "mqtt", - "description": "dummy MQTT broker", - "bindings": { - "mqtt": { - "clientId": "guest", - "cleanSession": true - } - } - }, - "dummy-amqp": { - "url": "amqp://localhost:{port}", - "protocol": "amqp", - "description": "dummy AMQP broker", - "protocolVersion": "0.9.1", - "variables": { - "port": { - "enum": [ - "15672", - "5672" - ] - } - }, - "security": [ - { - "user-password": [] - } - ] - }, - "dummy-kafka": { - "url": "http://localhost:{port}", - "protocol": "kafka", - "description": "dummy Kafka broker", - "variables": { - "port": { - "default": "9092" - } - } - } - }, - "defaultContentType": "application/json", - "channels": { - "dummy/channel/with/{dummy}/parameter/create": { - "x-dummy-security": { - "$ref": "#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials" - }, - "description": "Dummy channel description.", - "parameters": { - "dummy": { - "$ref": "#/components/parameters/dummy" - } - }, - "publish": { - "summary": "Inform whenever something dummy is created.", - "description": "Longer description.\n\nStill dummy though.\n", - "operationId": "receiveNewDummyInfo", - "tags": [ - { - "name": "oparation-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag3" - }, - { - "name": "oparation-tag4", - "description": "Description 4" - }, - { - "name": "oparation-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dummyCreated" - } - } - }, - "dummy/channel/without/parameter": { - "bindings": { - "amqp": { - "is": "routingKey" - } - }, - "subscribe": { - "operationId": "receiveSystemInfo", - "bindings": { - "amqp": { - "expiration": 100000, - "userId": "guest", - "cc": [ - "user.logs" - ], - "priority": 10, - "deliveryMode": 2, - "mandatory": false, - "bcc": [ - "external.audit" - ], - "replyTo": "user.signedup", - "timestamp": true, - "ack": false, - "bindingVersion": "0.1.0" - } - }, - "message": { - "$ref": "#/components/messages/dummyInfo" - } - } - } - }, - "components": { - "messages": { - "dummyCreated": { - "name": "dummyCreated", - "title": "Dummy created message", - "summary": "This is just a dummy create message", - "correlationId": { - "description": "This is a dummy correlation ID.", - "location": "$message.header#/correlationId" - }, - "tags": [ - { - "name": "message-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag3" - }, - { - "name": "message-tag4", - "description": "Description 4" - }, - { - "name": "message-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "headers": { - "type": "object", - "properties": { - "my-custom-app-header": { - "type": "string" - }, - "correlationId": { - "type": "string" - } - } - }, - "payload": { - "$ref": "#/components/schemas/dummyCreated" - }, - "bindings": { - "kafka": { - "key": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "type1", - "type2" - ] - } - } - }, - "bindingVersion": "0.1.0" - }, - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.1.0" - } - }, - "x-response": { - "$ref": "#/components/messages/dummyInfo" - } - }, - "dummyInfo": { - "name": "dummyInfo", - "title": "Dummy system info", - "summary": "This is just a dummy info message", - "correlationId": { - "location": "$message.header#/correlationId" - }, - "description": "More description for a dummy message.\n\nIt is a dummy system info message.\n", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dummyInfo" - }, - "examples": [ - { - "headers": { - "my-app-header": 12 - }, - "payload": { - "prop1": "option1", - "sentAt": "2020-01-31T13:24:53.000Z" - } - }, - { - "headers": { - "my-app-header": 13 - } - }, - { - "payload": { - "prop1": "option2", - "sentAt": "2020-01-31T13:24:53.000Z" - } - } - ] - } - }, - "schemas": { - "dummyCreated": { - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/components/schemas/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/components/schemas/dummyArrayWithArray" - }, - "dummyObject": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyArrayRank": { - "$ref": "#/components/schemas/dummyArrayRank" - } - } - }, - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/components/schemas/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/components/schemas/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - }, - "dummyArrayRank": { - "type": "object", - "properties": { - "dummyArrayValueRank": { - "$ref": "#/components/schemas/dummyArrayValueRank" - }, - "dummyArrayDimensions": { - "$ref": "#/components/schemas/dummyArrayArrayDimensions" - } - } - }, - "dummyArrayValueRank": { - "description": "This Attribute indicates whether the val Attribute of the datapoint is an array and how many dimensions the array has.\n", - "type": "integer", - "default": -1, - "examples": [ - 2 - ], - "oneOf": [ - { - "const": -1, - "description": "Scalar: The value is not an array." - }, - { - "const": 0, - "description": "OneOrMoreDimensions: The value is an array with one or more dimensions." - }, - { - "const": 1, - "description": "OneDimension: The value is an array with one dimension." - }, - { - "const": 2, - "description": "The value is an array with two dimensions." - } - ] - }, - "dummyArrayArrayDimensions": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0 - }, - "examples": [ - [ - 3, - 5 - ] - ] - } - }, - "securitySchemes": { - "user-password": { - "type": "userPassword" - }, - "apiKey": { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - }, - "supportedOauthFlows": { - "type": "oauth2", - "description": "Flows to support OAuth 2.0", - "flows": { - "implicit": { - "authorizationUrl": "https://authserver.example/auth", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "password": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "clientCredentials": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "authorizationCode": { - "authorizationUrl": "https://authserver.example/auth", - "tokenUrl": "https://authserver.example/token", - "refreshUrl": "https://authserver.example/refresh", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - } - } - }, - "openIdConnectWellKnown": { - "type": "openIdConnect", - "openIdConnectUrl": "https://authserver.example/.well-known" - } - }, - "parameters": { - "dummy": { - "description": "The ID of the new dummy message.", - "schema": { - "type": "string", - "description": "Description that not be rendered, as parameter has explicit description." - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - "correlationId": { - "type": "string" - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "groupId": "my-app-group-id", - "clientId": "my-app-client-id", - "bindingVersion": "0.1.0" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_0/zbos_mqtt-all-asyncapi.json b/test/blackbox/docs/AsyncAPI-2_0/zbos_mqtt-all-asyncapi.json deleted file mode 100644 index 2e0d42be06..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_0/zbos_mqtt-all-asyncapi.json +++ /dev/null @@ -1,23150 +0,0 @@ -{ - "asyncapi": "2.0.0", - "id": "urn:zbos-mqtt-api", - "defaultContentType": "application/json", - "info": { - "title": "ZBOS MQTT API", - "version": "2.6.3", - "description": "API for communication with ZBOS by Zora Robotics.", - "contact": { - "email": "info@zorarobotics.be" - } - }, - "servers": { - "local": { - "url": "127.0.0.1", - "protocol": "mqtt", - "description": "This is the local robot broker.", - "variables": { - "port": { - "enum": [ - "1883", - "9001" - ], - "default": "1883" - } - } - }, - "cloud": { - "url": "zbos-mqtt.zoracloud.com", - "protocol": "mqtt", - "description": "This is the cloud broker.", - "variables": { - "port": { - "enum": [ - "1883", - "1884", - "9001", - "9002" - ] - } - } - } - }, - "channels": { - "zbos/applications/categories/get": { - "publish": { - "summary": "Get application categories", - "description": "Get all application categories.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/applications/categories/get/response/{key}": { - "subscribe": { - "summary": "Response: Get application categories", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "weight": { - "type": "integer" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": [ - { - "id": "category_1", - "name": "Category 1", - "weight": 10 - }, - { - "id": "category_2", - "weight": 20, - "name_key": "category_2_key" - } - ] - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/apps/get": { - "publish": { - "summary": "Get applications", - "description": "Get all applications with optional filters.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "filters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field to check on. Note that the field should be camelCase, not snake_case" - }, - "value": { - "type": "string", - "description": "Value to check on. For numbers you should use 'min' and 'max'." - }, - "min": { - "type": "number", - "description": "Minimum value, only usable for number fields" - }, - "max": { - "type": "number", - "description": "Maximum value, only usable for number fields" - }, - "direction": { - "type": "object", - "description": "Direction to sort on.\nCan be 'asc' or 'desc'.\nThe default direction is 'asc'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "asc", - "desc" - ] - }, - "operator": { - "type": "object", - "description": "Operator for either the child filters, or this filter object itself.\nCan be 'and', 'or' or 'not'.\nDefault is 'and'.\nThe root operator is always 'and'", - "properties": { - "alternateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "and", - "or", - "not" - ] - }, - "match_type": { - "type": "object", - "description": "Match type for string values.\nCan be 'exact', 'contains', 'starts_with', 'ends_with'.\nThe default match_type is 'contains'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "exact", - "contains", - "starts_with", - "ends_with" - ] - }, - "filters": { - "type": "array", - "description": "Filters on which the operator will be applied.\nIf there are no child filters, the operator will be applied to the filter object itself.", - "items": { - "type": "object" - } - }, - "field_filters": { - "type": "array", - "description": "Filters to apply on the child fields of the field.\nWill only work if the field is an object, array/list or map.", - "items": { - "type": "object" - } - } - } - } - }, - "language": { - "type": "string", - "description": "Optional. Set the language to have all translations filled in.\nThe language format is ISO 639-1 language code, Eg: 'en' or 'en-US'" - } - } - }, - "name": "GetApplicationsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "limit": 20, - "offset": 20, - "filters": [ - { - "field": "category_id", - "value": "category_1", - "operator": "and", - "match_type": "exact" - } - ] - } - } - ] - } - } - }, - "zbos/applications/apps/get/response/{key}": { - "subscribe": { - "summary": "Response: Get applications", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This could be a package name, or some other defined unique ID" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "category_id": { - "type": "string" - }, - "weight": { - "type": "integer" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "application_id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "type": { - "type": "object", - "description": "List of available actions:\nopen: Opens an application handled by the RAILopen_control: Opens an application handled by the control\nsettings: Opens the settings, handled by the control\ndatasource: Edit the datasource, handled by the control\nother: Should be handled by the app itself", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "open", - "open_control", - "settings", - "datasources", - "other" - ] - }, - "data": { - "type": "object", - "description": "Optional data that an action might need." - } - } - } - }, - "optional": { - "type": "boolean", - "description": "Adds this application to the list of optional apps, which determines if the app is shown to the user" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": [ - { - "id": "com.zorabots.application.one", - "name": "Application 1", - "weight": 10, - "actions": [ - { - "name": "Open", - "type": "open", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.one" - }, - { - "name": "Settings", - "type": "settings", - "valid": true, - "application_id": "com.zorabots.application.one" - }, - { - "name": "Datasource", - "type": "datasources", - "valid": true, - "application_id": "com.zorabots.application.one" - } - ], - "optional": false, - "category_id": "category_1" - }, - { - "id": "com.zorabots.application.two", - "weight": 20, - "actions": [ - { - "type": "open", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.two", - "name_key": "Open" - }, - { - "name": "Some other action", - "type": "other", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.two" - } - ], - "optional": false, - "name_key": "application_2_key", - "category_id": "category_1" - } - ] - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/apps/changed/event/{app}": { - "publish": { - "summary": "Application changed", - "description": "Fired when an app was added or changed.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This could be a package name, or some other defined unique ID" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "category_id": { - "type": "string" - }, - "weight": { - "type": "integer" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "application_id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "type": { - "type": "object", - "description": "List of available actions:\nopen: Opens an application handled by the RAILopen_control: Opens an application handled by the control\nsettings: Opens the settings, handled by the control\ndatasource: Edit the datasource, handled by the control\nother: Should be handled by the app itself", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "open", - "open_control", - "settings", - "datasources", - "other" - ] - }, - "data": { - "type": "object", - "description": "Optional data that an action might need." - } - } - } - }, - "optional": { - "type": "boolean", - "description": "Adds this application to the list of optional apps, which determines if the app is shown to the user" - } - } - }, - "name": "Application", - "examples": [ - { - "payload": { - "id": "com.zorabots.application.one", - "name": "Application 1", - "weight": 10, - "actions": [ - { - "name": "Open", - "type": "open", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.one" - }, - { - "name": "Settings", - "type": "settings", - "valid": true, - "application_id": "com.zorabots.application.one" - }, - { - "name": "Datasource", - "type": "datasources", - "valid": true, - "application_id": "com.zorabots.application.one" - } - ], - "optional": false, - "category_id": "category_1" - } - } - ] - } - }, - "parameters": { - "app": { - "description": "ID of the app that was changed", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/icons/get": { - "publish": { - "summary": "Get application icon", - "description": "Get the application icons for the passed application ID.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "max_width": { - "type": "integer", - "description": "Optional, can be used to decrease payload size" - }, - "max_height": { - "type": "integer", - "description": "Optional, can be used to decrease payload size" - }, - "application_id": { - "type": "string" - } - } - }, - "name": "GetApplicationIconRequest", - "examples": [ - { - "payload": { - "key": "abc", - "valid": true, - "max_width": 100, - "max_height": 100, - "application_id": "com.zorabots.application.one" - } - } - ] - } - } - }, - "zbos/applications/icons/get/response/{key}": { - "subscribe": { - "summary": "Response: Get application icon", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "application_id": { - "type": "string" - }, - "icon": { - "type": "string", - "description": "Base 64 encoded PNG" - } - } - }, - "name": "ApplicationIcon", - "examples": [ - { - "payload": { - "icon": "{base64 encoded png}", - "application_id": "com.zorabots.application.one" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/actions/start": { - "publish": { - "summary": "Start application action", - "description": "Start an application action.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "application_id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "type": { - "type": "object", - "description": "List of available actions:\nopen: Opens an application handled by the RAILopen_control: Opens an application handled by the control\nsettings: Opens the settings, handled by the control\ndatasource: Edit the datasource, handled by the control\nother: Should be handled by the app itself", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "open", - "open_control", - "settings", - "datasources", - "other" - ] - }, - "data": { - "type": "object", - "description": "Optional data that an action might need." - } - } - }, - "name": "ApplicationAction", - "examples": [ - { - "payload": { - "name": "Open", - "type": "open", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.one" - } - }, - { - "payload": { - "name": "Settings", - "type": "settings", - "valid": true, - "application_id": "com.zorabots.application.one" - } - }, - { - "payload": { - "name": "Datasource", - "type": "datasources", - "valid": true, - "application_id": "com.zorabots.application.one" - } - }, - { - "payload": { - "name": "Some other action", - "type": "other", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.one" - } - } - ] - } - } - }, - "zbos/applications/actions/start/response/{key}": { - "subscribe": { - "summary": "Response: Start application action", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/registration/request": { - "publish": { - "summary": "Request application registrations", - "description": "Request all apps to register themselves using the topics below.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/applications/registration/add": { - "publish": { - "summary": "Add application registration", - "description": "Registers an application to the applications list. Should be executed every time the application is started.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "application": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This could be a package name, or some other defined unique ID" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "category_id": { - "type": "string" - }, - "weight": { - "type": "integer" - }, - "actions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "application_id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "name_key": { - "type": "string", - "description": "Use name for a static name, or name_key for a translatable name" - }, - "type": { - "type": "object", - "description": "List of available actions:\nopen: Opens an application handled by the RAILopen_control: Opens an application handled by the control\nsettings: Opens the settings, handled by the control\ndatasource: Edit the datasource, handled by the control\nother: Should be handled by the app itself", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "open", - "open_control", - "settings", - "datasources", - "other" - ] - }, - "data": { - "type": "object", - "description": "Optional data that an action might need." - } - } - } - }, - "optional": { - "type": "boolean", - "description": "Adds this application to the list of optional apps, which determines if the app is shown to the user" - } - } - } - } - }, - "name": "RegisterApplicationRequest", - "examples": [ - { - "payload": { - "key": "abc", - "application": { - "id": "com.zorabots.application.one", - "name": "Application 1", - "weight": 10, - "actions": [ - { - "name": "Open", - "type": "open", - "data": { - "key1": "value1" - }, - "valid": true, - "application_id": "com.zorabots.application.one" - }, - { - "name": "Settings", - "type": "settings", - "valid": true, - "application_id": "com.zorabots.application.one" - } - ], - "optional": false, - "category_id": "category_1" - }, - "valid": false - } - } - ] - } - } - }, - "zbos/applications/registration/add/response/{key}": { - "publish": { - "summary": "Response: Add application registration", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/registration/remove": { - "publish": { - "summary": "Remove application registration", - "description": "Unregister an application from the applications list.\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "id": { - "type": "string" - } - } - }, - "name": "UnregisterApplicationRequest", - "examples": [ - { - "payload": { - "key": "abc", - "id": "com.zorabots.application.one", - "valid": true - } - } - ] - } - } - }, - "zbos/applications/registration/remove/response/{key}": { - "publish": { - "summary": "Response: Remove application registration", - "description": "", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/datasources/get": { - "publish": { - "summary": "Get the content of a specific application datasource file", - "description": "Publish on this topic to get the content of a datasource\nPayload is json with a key for the response topic {\"key\":aKey}\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "applicationName": { - "type": "string" - }, - "datasourceId": { - "type": "string" - } - } - }, - "name": "DatasourceGetRequest", - "examples": [ - { - "payload": { - "applicationName": "string", - "datasourceId": "string", - "valid": true - } - } - ] - } - } - }, - "zbos/applications/datasources/get/response/{key}": { - "subscribe": { - "summary": "Response: Get datasource", - "description": "Will return a JSON string with the content of the datasource data file\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/applications/datasources/set": { - "publish": { - "summary": "Save the datasource", - "description": "Publish on this topic to save the datasource data (changes)\nPayload is json with a key for the response topic {\"key\":aKey}\nThe Payload is a JSON string of an object with following keys: application name, datasource id and datasource data\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "applicationName": { - "type": "string" - }, - "datasourceId": { - "type": "string" - }, - "datasourceData": { - "type": "string" - } - } - }, - "name": "DatasourceSetRequest", - "examples": [ - { - "payload": { - "applicationName": "string", - "datasourceId": "string", - "datasourceData": "string", - "valid": true - } - } - ] - } - } - }, - "zbos/applications/datasources/set/response/{key}": { - "subscribe": { - "summary": "Response: Datasource saved", - "description": "A message object (with key 'success') is publish on this topic when the datasource has been saved\n", - "tags": [ - { - "name": "Applications", - "description": "All applications related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/audio/player/start": { - "publish": { - "summary": "Play media", - "description": "Play specific media from audio options\n", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "url": { - "type": "string" - }, - "loop": { - "type": "boolean" - } - } - }, - "name": "AudioOptions", - "examples": [ - { - "payload": { - "requestId": "1", - "url": "Url", - "loop": true - } - } - ] - } - } - }, - "zbos/audio/player/stop": { - "publish": { - "summary": "Stop media", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/audio/player/ended": { - "subscribe": { - "summary": "Media ended", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": { - "requestId": "1", - "url": "Url" - } - } - ] - } - } - }, - "zbos/audio/player/pause": { - "publish": { - "summary": "Pause media", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/audio/player/resume": { - "publish": { - "summary": "Resume media", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/audio/volume/set": { - "publish": { - "summary": "Set volume", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "payload": { - "type": "integer", - "maximum": 100, - "minimum": 0 - }, - "name": "Int" - } - } - }, - "zbos/audio/volume/get": { - "publish": { - "summary": "Get volume", - "description": "see <> for response\n", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/audio/volume/response/{key}": { - "subscribe": { - "summary": "response: Get volume", - "description": "", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "payload": { - "type": "integer", - "maximum": 100, - "minimum": 0 - }, - "name": "Int" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/audio/volume/event": { - "subscribe": { - "summary": "event: Volume change", - "description": "Notify subscribers of a volume change.\n", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "payload": { - "type": "integer", - "maximum": 100, - "minimum": 0 - }, - "name": "Int" - } - } - }, - "zbos/audio/beep": { - "publish": { - "summary": "Play beep", - "description": "Publish to play a beep sound. Used by the robot when the hot word is recognized.\n", - "tags": [ - { - "name": "Audio", - "description": "All audio related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/picture/get": { - "publish": { - "summary": "Get picture", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/camera/picture/event": { - "publish": { - "summary": "event: Get picture", - "description": "Picture in base64 formatsee zbos/facetracking/response for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/camera/stream/start": { - "publish": { - "summary": "Start the camera stream of the selected camera.", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "cameraId": { - "type": "string", - "description": "Camera id" - }, - "extras": { - "type": "object" - } - } - }, - "name": "StreamStartRequest", - "examples": [ - { - "payload": { - "cameraId": "string", - "extras": {} - } - } - ] - } - } - }, - "zbos/camera/stream/stop": { - "publish": { - "summary": "Stop camera stream", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "cameraId": { - "type": "string", - "description": "camera id" - } - } - }, - "name": "VideoOptions", - "examples": [ - { - "payload": { - "requestId": "string", - "cameraId": "string" - } - } - ] - } - } - }, - "zbos/camera/stream/stop/event": { - "subscribe": { - "summary": "Camera stream has stopped", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/stream/init": { - "publish": { - "summary": "Initialize camera stream", - "description": "Send by the robot to start the webrtc handshake\n", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/stream/offer": { - "description": "WebRTC Session Description", - "publish": { - "summary": "Handsake offer for camera stream", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/camera/stream/answer": { - "description": "WebRTC Session Description", - "subscribe": { - "summary": "Handsake answer for camera stream", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "OFFER", - "PRANSWER", - "ANSWER" - ] - }, - "sdp": { - "type": "string" - } - } - }, - "name": "StreamAnswer", - "examples": [ - { - "payload": { - "type": "ANSWER", - "sdp": "string" - } - } - ] - } - } - }, - "zbos/camera/stream/candidate/core": { - "description": "WebRTC Session Description", - "subscribe": { - "summary": "RTC ICE Candidate Core", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "cameraId": { - "type": "string", - "description": "camera id" - }, - "type": { - "type": "string", - "description": "Always returns \"candidate\"" - }, - "label": { - "type": "integer", - "description": "sdpMLineIndex" - }, - "id": { - "type": "string", - "description": "sdpMid" - }, - "candidate": { - "type": "string" - } - } - }, - "name": "Candidate", - "examples": [ - { - "payload": { - "cameraId": "string", - "type": "string", - "label": 5, - "id": "string", - "candidate": "string" - } - } - ] - } - } - }, - "zbos/camera/stream/candidate/control": { - "subscribe": { - "summary": "RTC ICE Candidate Control", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "cameraId": { - "type": "string", - "description": "camera id" - }, - "type": { - "type": "string", - "description": "Always returns \"candidate\"" - }, - "label": { - "type": "integer", - "description": "sdpMLineIndex" - }, - "id": { - "type": "string", - "description": "sdpMid" - }, - "candidate": { - "type": "string" - } - } - }, - "name": "Candidate", - "examples": [ - { - "payload": { - "cameraId": "string", - "type": "string", - "label": 5, - "id": "string", - "candidate": "string" - } - } - ] - } - } - }, - "zbos/camera/stream/twoway/request": { - "publish": { - "summary": "Request two way camera stream", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/preview/resume": { - "publish": { - "summary": "Resume camera preview", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/preview/pause": { - "publish": { - "summary": "Pause camera preview", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/error": { - "publish": { - "summary": "Camera error", - "description": "", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/camera/qr/scan/start": { - "publish": { - "summary": "Start QR Scanning", - "description": "Start a QR code scan using the camera.\n", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "scan_id": { - "type": "string", - "description": "Unique ID that will be used in related topics." - }, - "scan_timeout": { - "type": "integer", - "description": "Timeout in seconds after which the scan should automatically be stopped.\nPass 0 to not have a timeout. 0 is also the default when no value was passed." - } - } - }, - "name": "QrScanStartRequest", - "examples": [ - { - "payload": { - "scan_id": "abc", - "scan_timeout": 60 - } - }, - { - "payload": { - "scan_id": "xyz", - "scan_timeout": 0 - } - } - ] - } - } - }, - "zbos/camera/qr/scan/stop": { - "publish": { - "summary": "Stop QR Scanning", - "description": "Stop a QR code scan using the camera.\n", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "scan_id": { - "type": "string", - "description": "Unique ID that should be the same as the one used in the start request." - } - } - }, - "name": "QrScanStopRequest", - "examples": [ - { - "payload": { - "scan_id": "abc" - } - } - ] - } - } - }, - "zbos/camera/qr/scan/stopped/event": { - "subscribe": { - "summary": "Event: Stopped QR scanning", - "description": "This event is published when a QR scan has stopped, either manually or due to a timeout.\n", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "scan_id": { - "type": "string", - "description": "Unique ID that will be the same as the one used in the start request." - } - } - }, - "name": "QrScanStoppedEvent", - "examples": [ - { - "payload": { - "scan_id": "abc" - } - } - ] - } - } - }, - "zbos/camera/qr/result/event": { - "subscribe": { - "summary": "QR Result Event", - "description": "This event is published every time a QR code is decoded while a scan is active.\n", - "tags": [ - { - "name": "Camera", - "description": "All camera related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "content": { - "type": "string" - } - } - }, - "name": "QrResultEvent", - "examples": [ - { - "payload": { - "content": "QR Code Content" - } - } - ] - } - } - }, - "zbos/cloud/login": { - "publish": { - "summary": "Login to the cloud", - "description": "see <> for response\n", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/cloud/login/response": { - "subscribe": { - "summary": "response: Login to the cloud", - "description": "Response indicating if login to the cloud was successful or not\n", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "token": { - "type": "string", - "description": "jwt auth token" - }, - "success": { - "type": "boolean" - } - } - }, - "name": "LoginResponse", - "examples": [ - { - "payload": { - "token": "string", - "success": true - } - } - ] - } - } - }, - "zbos/cloud/config/get": { - "publish": { - "summary": "Get cloud config", - "description": "see <> for response\n", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/cloud/config/response/{key}": { - "subscribe": { - "summary": "response: Get cloud config", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "Map" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/cloud/config/set": { - "publish": { - "summary": "Set cloud config", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "Map" - } - } - }, - "zbos/cloud/config/event": { - "subscribe": { - "summary": "event: Config cloud", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "Map" - } - } - }, - "zbos/media/library/resync": { - "publish": { - "summary": "Resync all media libraries", - "description": "see <> for response\n", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/library/resync/response/{key}": { - "subscribe": { - "summary": "response: Resync all media libraries", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/media/library/file/upload": { - "publish": { - "summary": "Upload file in media library", - "description": "see <> for response\n", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "file": { - "type": "string" - }, - "storageAccount": { - "type": "string" - }, - "key": { - "type": "string" - }, - "metadata": { - "type": "object" - } - } - }, - "name": "FileUploadRequest", - "examples": [ - { - "payload": { - "file": "string", - "storageAccount": "string", - "key": "string", - "metadata": {} - } - } - ] - } - } - }, - "zbos/media/library/file/upload/response/{key}": { - "subscribe": { - "summary": "response: Upload file in media library", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "cloudFileId": { - "type": "string" - } - } - }, - "name": "CloudResult", - "examples": [ - { - "payload": { - "success": false, - "cloudFileId": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/cloud/user/list": { - "publish": { - "summary": "Request users linked to the robot", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "offset": { - "type": "number" - }, - "limit": { - "type": "number" - } - } - }, - "name": "LinkedUsersRequest" - } - } - }, - "zbos/cloud/user/list/response/{key}": { - "subscribe": { - "summary": "response: users linked to the robot", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "accounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - }, - "email": { - "type": "string" - }, - "picture": { - "type": "string" - }, - "admin": { - "type": "boolean" - }, - "mqttAccount": { - "type": "string" - } - } - } - }, - "offset": { - "type": "number" - }, - "limit": { - "type": "number" - }, - "numResults": { - "type": "number" - } - } - }, - "name": "LinkedUsersResponse", - "examples": [ - { - "payload": { - "accounts": [ - { - "id": "cffb2596-662f-479a-8f43-af1651a61c6d", - "username": "John Doe", - "email": "someone@zorabots.be", - "picture": "https://lh3.googleusercontent.com/a/AATXAJy1DGqwgHZMEiiz=s96-c", - "admin": true, - "mqttAccount": "c-1b32e964-0d76-4ce4-bc61-f8e05bdcebf9" - } - ], - "offset": 0, - "limit": 20, - "numResults": 1 - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/cloud/license/list": { - "publish": { - "summary": "Request a license list for the robot", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "offset": { - "type": "number" - }, - "limit": { - "type": "number" - } - } - }, - "name": "LicenseListRequest" - } - } - }, - "zbos/cloud/license/list/response/{key}": { - "subscribe": { - "summary": "response: Request linking a user to the robot", - "description": "", - "tags": [ - { - "name": "Cloud", - "description": "All cloud related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "licenses": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "serial": { - "type": "string" - }, - "softwareId": { - "type": "string" - }, - "createdTimestamp": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "validFrom": { - "type": "integer" - }, - "validUntil": { - "type": "integer" - } - } - } - }, - "offset": { - "type": "number" - }, - "limit": { - "type": "number" - }, - "numResults": { - "type": "number" - } - } - }, - "name": "LicenseListResponse", - "examples": [ - { - "payload": { - "licenses": [ - { - "id": "7c18ae59-1d2c-4fbb-b7e8-4f07fd7b20d4", - "serial": "SH- J02 000596", - "createdTimestamp": 1618783200, - "type": "LICENSE_TYPE_ROBOT", - "validFrom": 1618783200, - "validUntil": 1651017599 - }, - { - "id": "7c18ae59-1d2c-4fbb-b7e8-4f07fd7b20d4", - "serial": "SH- J02 000596", - "softwareId": "73143543-98bf-4ac6-8992-d8b097bbea27", - "createdTimestamp": 1623329499, - "type": "LICENSE_TYPE_SOFTWARE", - "validFrom": 1623276000, - "validUntil": 1654984799 - } - ], - "offset": 0, - "limit": 20, - "numResults": 2 - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/composition/start": { - "publish": { - "summary": "Start composition", - "description": "Payload is composition json\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/composition/start/id": { - "publish": { - "summary": "Start composition by id", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "settings": { - "type": "object", - "properties": { - "pinned": { - "type": "boolean" - }, - "schedulerParallel": { - "type": "boolean" - } - } - }, - "variables": { - "type": "object" - } - } - }, - "name": "CompositionStartRequest", - "examples": [ - { - "payload": { - "id": "string", - "settings": { - "pinned": false, - "schedulerParallel": false - }, - "variables": { - "var1": "var1_value", - "var2": "var2_value" - } - } - } - ] - } - } - }, - "zbos/{source}/start/event": { - "subscribe": { - "summary": "event: Composition started", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/{source}/stop": { - "publish": { - "summary": "Stop composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/{source}/stop/event": { - "subscribe": { - "summary": "event: Composition stopped", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/composition/pause": { - "publish": { - "summary": "Pause composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/pause/event": { - "subscribe": { - "summary": "event: Composition paused", - "description": "Timeline ID\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/composition/resume": { - "publish": { - "summary": "Resume composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/resume/event": { - "subscribe": { - "summary": "event: Composition Resumed", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/{source}/loop/event": { - "subscribe": { - "summary": "event: Composition loop state", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "infinite": { - "type": "boolean" - }, - "repeatTimes": { - "type": "integer", - "description": "Total loop count" - }, - "currentRepeatTimes": { - "type": "integer", - "description": "current loop count" - } - } - }, - "name": "LoopProperty", - "examples": [ - { - "payload": { - "infinite": true, - "currentRepeatTimes": 3 - } - } - ] - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/composition/settings": { - "publish": { - "summary": "Settings for a given composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "loop": { - "type": "object", - "properties": { - "infinite": { - "type": "boolean" - }, - "repeatTimes": { - "type": "integer", - "description": "Total loop count" - }, - "currentRepeatTimes": { - "type": "integer", - "description": "current loop count" - } - } - }, - "general": { - "type": "object", - "properties": { - "stoppable": { - "type": "boolean" - }, - "powerManagement": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "AWARE", - "DISABLED" - ] - } - } - } - } - }, - "timelineId": { - "type": "string", - "description": "Composition ID" - }, - "isScheduler": { - "type": "boolean" - }, - "isPinned": { - "type": "boolean" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "SIMPLE_COMPOSITION", - "ADVANCED_COMPOSITION" - ] - } - } - }, - "name": "TimelinePropertiesWrapper", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/composition/save": { - "publish": { - "summary": "Save composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/save/multiple": { - "publish": { - "summary": "Save multiple compositions", - "description": "see <> for response\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Required key" - }, - "compositions": { - "type": "array", - "description": "Array of compositions", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "SIMPLE_COMPOSITION", - "ADVANCED_COMPOSITION" - ] - } - } - } - } - } - }, - "name": "SaveMultipleCompositionRequest", - "examples": [ - { - "payload": { - "compositions": [ - { - "id": "string", - "name": "string", - "type": "SIMPLE_COMPOSITION" - } - ] - } - } - ] - } - } - }, - "zbos/composition/save/event": { - "subscribe": { - "summary": "event: Composition Saved", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "string" - } - ] - } - } - }, - "zbos/composition/save/multiple/response/{key}": { - "subscribe": { - "summary": "response: Save multiple compositions", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "Map" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/composition/load": { - "publish": { - "summary": "Load composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "name": "CompositionLoadRequest", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/composition/load/event": { - "subscribe": { - "summary": "event: Composition loaded", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/composition/list": { - "publish": { - "summary": "Get list of compositions", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/list/event": { - "subscribe": { - "summary": "event: Get list of compositions", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "SIMPLE_COMPOSITION", - "ADVANCED_COMPOSITION" - ] - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string", - "type": "SIMPLE_COMPOSITION" - } - } - ] - } - } - }, - "zbos/composition/delete": { - "publish": { - "summary": "Delete composition by id", - "description": "see <> for response\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "name": "CompositionDeleteRequest", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/composition/delete/all": { - "publish": { - "summary": "Deletes all compositions", - "description": "see <> for response\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/delete/response": { - "subscribe": { - "summary": "response: Delete composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/composition/changed/event": { - "subscribe": { - "summary": "event: Composition changed", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/audio/stop": { - "publish": { - "summary": "Stop audio composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/video/stop": { - "publish": { - "summary": "Stop video composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/image/stop": { - "publish": { - "summary": "Stop image composition", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/composition/error": { - "subscribe": { - "summary": "event: Composition encountered error", - "description": "List of possible error reasons:\n'INVALID_ID': The block id is malformed/broken.\n'INVALID_TYPE': The block type is malformed/broken.\n'INVALID_BLOCK': One of the properties aside from id and type is malformed/broken.\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Block type that caused the error, 'UNKNOWN' if not known" - }, - "id": { - "type": "string", - "description": "Block ID that caused the error, 'UNKNOWN' if not known" - }, - "reasons": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "CompositionError", - "examples": [ - { - "payload": { - "type": "string", - "id": "string" - } - } - ] - } - } - }, - "zbos/api/request": { - "publish": { - "summary": "Get api", - "description": "see <> for response\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "endpoint": { - "type": "string" - }, - "body": { - "type": "string" - }, - "params": { - "type": "object" - }, - "headers": { - "type": "object" - } - } - }, - "name": "ApiRequestBlock", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/api/response/{key}": { - "subscribe": { - "summary": "response: Get api", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/composition/default/variable/request": { - "publish": { - "summary": "Get default composition variables", - "description": "Payload \"key\" is optionalsee <> for response\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/composition/default/variable/response/{key}": { - "subscribe": { - "summary": "response: Get default composition variables", - "description": "Payload is array of variable names\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": "Array" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/composition/status/get": { - "publish": { - "summary": "Get composition statussee <> for response", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/composition/status/response/{key}": { - "subscribe": { - "summary": "response: Composition status", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "state": { - "type": "object", - "description": "Default, playing or paused", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "PLAYING", - "PAUSED" - ] - }, - "activeBlocks": { - "type": "array", - "items": { - "type": "string" - } - }, - "properties": { - "type": "object", - "description": "Composition properties", - "properties": { - "loop": { - "type": "object", - "properties": { - "infinite": { - "type": "boolean" - }, - "repeatTimes": { - "type": "integer", - "description": "Total loop count" - }, - "currentRepeatTimes": { - "type": "integer", - "description": "current loop count" - } - } - }, - "general": { - "type": "object", - "properties": { - "stoppable": { - "type": "boolean" - }, - "powerManagement": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "AWARE", - "DISABLED" - ] - } - } - } - } - }, - "playCount": { - "type": "integer", - "description": "Current repeat iteration" - } - } - }, - "name": "CompositionStatus", - "examples": [ - { - "payload": { - "id": "string", - "state": "DEFAULT", - "activeBlocks": [ - "string" - ], - "properties": { - "loop": { - "infinite": true, - "currentRepeatTimes": 3 - }, - "general": { - "powerManagement": "DEFAULT" - } - }, - "playCount": 5 - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/composition/block/start": { - "publish": { - "summary": "Start composition block", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Block ID" - }, - "index": { - "type": "integer" - }, - "blocking": { - "type": "boolean" - }, - "input": { - "type": "object", - "properties": { - "connectors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "blockId": { - "type": "string" - }, - "connectorId": { - "type": "string" - } - } - } - } - } - } - } - }, - "output": { - "type": "object", - "properties": { - "connectors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "connection": { - "type": "object", - "properties": { - "blockId": { - "type": "string" - }, - "connectorId": { - "type": "string" - } - } - } - } - } - } - } - }, - "nextBlockId": { - "type": "string" - } - } - }, - "name": "Block", - "examples": [ - { - "payload": { - "index": 5, - "blocking": false, - "nextBlockId": "string" - } - } - ] - } - } - }, - "zbos/{source}/block/start/event": { - "subscribe": { - "summary": "event: Composition block started", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/composition/block/stop": { - "publish": { - "summary": "Stop composition block", - "description": "Block ID to stop, when key = \"all\", all active blocks will be stopped.\n", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/{source}/block/end/event": { - "subscribe": { - "summary": "event: Composition block ended", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/{source}/block/pause/event": { - "subscribe": { - "summary": "event: Composition block paused", - "description": "", - "tags": [ - { - "name": "Composer", - "description": "All composer related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "source": { - "description": "The source that this composition belongs to", - "schema": { - "type": "string", - "enum": [ - "scheduler/timeline", - "composition" - ] - } - } - } - }, - "zbos/connection/status/get": { - "publish": { - "summary": "Get the connection status", - "description": "Requesting the connection information for the WiFi, access point and cablesee <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/connection/status/response/{key}": { - "subscribe": { - "summary": "response: Get the connection status", - "description": "Response with the status information for the WiFi, access point and cable\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "wifi": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "ip4": { - "type": "string" - }, - "ip6": { - "type": "string" - }, - "dhcp": { - "type": "boolean" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "dns": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "macAddress": { - "type": "string" - }, - "connectionStatus": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "CONNECTING", - "CONNECTED", - "DISCONNECTED" - ] - }, - "hasInternet": { - "type": "boolean" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "cable": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ip4": { - "type": "string" - }, - "ip6": { - "type": "string" - }, - "dhcp": { - "type": "boolean" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "dns": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "macAddress": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "ap": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "ip": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "cellular": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "macAddress": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - } - } - } - }, - "name": "ConnectionStatus", - "examples": [ - { - "payload": { - "wifi": [ - { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "ip4": "192.168.0.5", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "macAddress": "76:EA:A5:27:6B:B6", - "connectionStatus": "CONNECTED", - "hasInternet": true, - "adapterName": "wlan0" - } - ], - "cable": [ - { - "ip4": "192.168.0.4", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "hasConnection": true, - "hasInternet": true, - "adapterName": "eth0" - } - ], - "ap": [ - { - "ssid": "ZoraBotsHotspot", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth0" - } - ], - "cellular": [ - { - "hasConnection": true, - "hasInternet": true, - "macAddress": "some-mac-address", - "adapterName": "ccmni0" - } - ] - } - }, - { - "payload": { - "cable": [ - { - "ip4": "192.168.0.4", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "hasConnection": true, - "hasInternet": true, - "adapterName": "eth0" - } - ] - } - }, - { - "payload": { - "wifi": [ - { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "ip4": "192.168.0.5", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "macAddress": "76:EA:A5:27:6B:B6", - "connectionStatus": "CONNECTED", - "hasInternet": true, - "adapterName": "wlan0" - } - ] - } - }, - { - "payload": { - "ap": [ - { - "ssid": "ZoraBotsHotspot", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth0" - }, - { - "ssid": "ZoraBotsHotspot5GHz", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth1" - } - ] - } - }, - { - "payload": { - "cellular": [ - { - "hasConnection": true, - "hasInternet": true, - "macAddress": "some-mac-address", - "adapterName": "ccmni0" - } - ] - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/status/event": { - "subscribe": { - "summary": "event: Connection status", - "description": "Periodic status information for the WiFi, access point and cable\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "wifi": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "ip4": { - "type": "string" - }, - "ip6": { - "type": "string" - }, - "dhcp": { - "type": "boolean" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "dns": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "macAddress": { - "type": "string" - }, - "connectionStatus": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "CONNECTING", - "CONNECTED", - "DISCONNECTED" - ] - }, - "hasInternet": { - "type": "boolean" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "cable": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ip4": { - "type": "string" - }, - "ip6": { - "type": "string" - }, - "dhcp": { - "type": "boolean" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "dns": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "macAddress": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "ap": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "ip": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "adapterName": { - "type": "string" - } - } - } - }, - "cellular": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hasConnection": { - "type": "boolean" - }, - "hasInternet": { - "type": "boolean" - }, - "macAddress": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - } - } - } - }, - "name": "ConnectionStatus", - "examples": [ - { - "payload": { - "wifi": [ - { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "ip4": "192.168.0.5", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "macAddress": "76:EA:A5:27:6B:B6", - "connectionStatus": "CONNECTED", - "hasInternet": true, - "adapterName": "wlan0" - } - ], - "cable": [ - { - "ip4": "192.168.0.4", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "hasConnection": true, - "hasInternet": true, - "adapterName": "eth0" - } - ], - "ap": [ - { - "ssid": "ZoraBotsHotspot", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth0" - } - ], - "cellular": [ - { - "hasConnection": true, - "hasInternet": true, - "macAddress": "some-mac-address", - "adapterName": "ccmni0" - } - ] - } - }, - { - "payload": { - "cable": [ - { - "ip4": "192.168.0.4", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711a", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "hasConnection": true, - "hasInternet": true, - "adapterName": "eth0" - } - ] - } - }, - { - "payload": { - "wifi": [ - { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "ip4": "192.168.0.5", - "ip6": "2a02:1811:b282:ae00:5850:a744:3c37:711b", - "dhcp": true, - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.1", - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - }, - "macAddress": "76:EA:A5:27:6B:B6", - "connectionStatus": "CONNECTED", - "hasInternet": true, - "adapterName": "wlan0" - } - ] - } - }, - { - "payload": { - "ap": [ - { - "ssid": "ZoraBotsHotspot", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth0" - }, - { - "ssid": "ZoraBotsHotspot5GHz", - "ip": "192.168.60.1", - "encryption": "WPA2_PSK", - "hasConnection": true, - "hasInternet": true, - "adapterName": "teth1" - } - ] - } - }, - { - "payload": { - "cellular": [ - { - "hasConnection": true, - "hasInternet": true, - "macAddress": "some-mac-address", - "adapterName": "ccmni0" - } - ] - } - } - ] - } - } - }, - "zbos/connection/wifi/scan": { - "publish": { - "summary": "Scan for WiFi networks", - "description": "Start scanning for WiFi networks\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/connection/wifi/scan/event": { - "subscribe": { - "summary": "response: Scan for WiFi networks", - "description": "A list of all the scanned WiFi networks the robot can connect to\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "signal": { - "type": "integer" - }, - "isSaved": { - "type": "boolean" - }, - "macAddress": { - "type": "string" - }, - "channel": { - "type": "integer" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "signal": -60, - "macAddress": "83:E0:F9:55:95:AF", - "saved": false - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkEnterprise", - "encryption": "WPA2_EAP", - "signal": -55, - "macAddress": "83:E0:F9:55:95:AF", - "saved": false - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkOpen", - "encryption": "UNSECURE", - "signal": -50, - "macAddress": "83:E0:F9:55:95:AF", - "saved": false - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkWEP", - "encryption": "WEP", - "signal": -70, - "macAddress": "83:E0:F9:55:95:AF", - "saved": false - } - } - ] - } - } - }, - "zbos/connection/wifi/connect": { - "publish": { - "summary": "Connect to a network", - "description": "Connect to a specific WiFi network\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "password": { - "type": "string" - }, - "username": { - "type": "string" - }, - "macAddress": { - "type": "string" - }, - "isSaved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "channel": { - "type": "integer" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "ConnectToNetwork", - "examples": [ - { - "payload": { - "ssid": "ZoraNetwork1", - "encryption": "WPA2_PSK", - "password": "Nice_try123", - "macAddress": "83:E0:F9:55:95:AF", - "hidden": false, - "adapterName": "wlan0", - "saved": false, - "enterpriseNetwork": false, - "valid": true - } - } - ] - } - } - }, - "zbos/connection/wifi/connect/event": { - "subscribe": { - "summary": "event: Connect to a network", - "description": "A (json) message is published when the connection request was successful or not\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "name": "ConnectionResponse", - "examples": [ - { - "payload": { - "success": true, - "message": "ZoraBotsNetwork" - } - }, - { - "payload": { - "success": true, - "message": "" - } - }, - { - "payload": { - "success": false, - "message": "INVALID_CREDENTIALS" - } - } - ] - } - } - }, - "zbos/connection/wifi/forget": { - "publish": { - "summary": "Forget a network", - "description": "Forget a network. If the robot is connected to the given network, it will disconnect\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "macAddress": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "ForgetNetwork", - "examples": [ - { - "payload": { - "ssid": "ZoraBotsNetworkEnterprise", - "macAddress": "wifi_wxvze5651", - "adapterName": "wlan0", - "valid": true - } - } - ] - } - } - }, - "zbos/connection/wifi/forget/event": { - "subscribe": { - "summary": "event: Forget a network", - "description": "A (json) message is published when the forget request was successful or not\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "name": "ConnectionResponse", - "examples": [ - { - "payload": { - "success": true, - "message": "ZoraBotsNetwork" - } - }, - { - "payload": { - "success": true, - "message": "" - } - }, - { - "payload": { - "success": false, - "message": "INVALID_CREDENTIALS" - } - } - ] - } - } - }, - "zbos/connection/wifi/list/saved/get": { - "publish": { - "summary": "Get the saved networks", - "description": "Get an overview of all the networks that are saved on the robotsee <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/connection/wifi/list/saved/response/{key}": { - "subscribe": { - "summary": "response: Get the saved networks", - "description": "A list of all the saved networks that are stored on the robot\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ssid": { - "type": "string" - }, - "encryption": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "UNSECURE", - "SHARE", - "WEP", - "WPA", - "WPA_PSK", - "WPA_OR_WPA2", - "WPA_OR_WPA2_PSK", - "WPA2", - "WPA2_PSK", - "WPA2_EAP", - "WAI_CERT", - "WAI_PSK" - ] - }, - "password": { - "type": "string" - }, - "username": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "networkConfig": { - "type": "object", - "properties": { - "dhcp": { - "type": "boolean" - }, - "fixedIp4": { - "type": "string" - }, - "fixedIp6": { - "type": "string" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "dns": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "ssid": "ZoraBotsNetwork", - "encryption": "WPA2_PSK", - "password": "Nice_try123", - "hidden": false, - "networkConfig": { - "dhcp": false, - "fixedIp4": "192.168.5.2", - "subnetmask": "255.255.255.0", - "gateway": "192.168.5.1", - "valid": true - }, - "dns": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "valid": true - } - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkEnterprise", - "encryption": "WPA2_EAP", - "password": "Nice_try123", - "username": "let_me_see", - "hidden": false - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkOpen", - "encryption": "UNSECURE", - "hidden": false - } - }, - { - "payload": { - "ssid": "ZoraBotsNetworkHidden", - "encryption": "WEP", - "password": "Nice_try123", - "hidden": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/wifi/network/configure/set": { - "publish": { - "summary": "Set network configuration", - "description": "Set specific WiFi network configuration (DHCP, IPv4, IPv6, subnetmask, default gateway).see <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "dhcp": { - "type": "boolean" - }, - "fixedIp4": { - "type": "string" - }, - "fixedIp6": { - "type": "string" - }, - "subnetmask": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "NetworkConfig", - "examples": [ - { - "payload": { - "dhcp": false, - "fixedIp4": "192.168.0.101", - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.2", - "adapterName": "wlan0", - "valid": true - } - }, - { - "payload": { - "dhcp": false, - "fixedIp4": "192.168.0.101", - "fixedIp6": "2a02:1811:b282:ae00:5850:a744:3c37:711b", - "subnetmask": "255.255.254.0", - "gateway": "192.168.0.2", - "adapterName": "wlan1", - "valid": true - } - }, - { - "payload": { - "dhcp": true, - "valid": true - } - } - ] - } - } - }, - "zbos/connection/wifi/network/configure/response/{key}": { - "subscribe": { - "summary": "response: Set network configuration", - "description": "A (json) message is published when saving the configuration was successful or not\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "name": "ConnectionResponse", - "examples": [ - { - "payload": { - "success": true, - "message": "ZoraBotsNetwork" - } - }, - { - "payload": { - "success": true, - "message": "" - } - }, - { - "payload": { - "success": false, - "message": "INVALID_CREDENTIALS" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/wifi/dns/get": { - "publish": { - "summary": "Get DNS configuration", - "description": "Get the DNS configuration of the network the robot is connected tosee <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/connection/wifi/dns/get/response/{key}": { - "subscribe": { - "summary": "response: Get DNS configuration", - "description": "Response with the DNS configuration of the connected network\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "DNSConfig", - "examples": [ - { - "payload": { - "dns1": "8.8.8.8", - "dns2": "8.8.4.4", - "adapterName": "wlan0", - "valid": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/wifi/dns/set": { - "publish": { - "summary": "Set DNS configuration", - "description": "Set the DNS configuration of the network the robot is connected to.see <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "dns1": { - "type": "string" - }, - "dns2": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "DNSConfig", - "examples": [ - { - "payload": { - "dns1": "1.1.1.1", - "dns2": "1.0.0.1", - "adapterName": "wlan0", - "valid": true - } - } - ] - } - } - }, - "zbos/connection/wifi/dns/set/response/{key}": { - "subscribe": { - "summary": "response: Set DNS configuration", - "description": "A (json) message is published when saving the DNS configuration was successful or not\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "name": "ConnectionResponse", - "examples": [ - { - "payload": { - "success": true, - "message": "ZoraBotsNetwork" - } - }, - { - "payload": { - "success": true, - "message": "" - } - }, - { - "payload": { - "success": false, - "message": "INVALID_CREDENTIALS" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/ap/config/get": { - "publish": { - "summary": "Get access point configuration", - "description": "Get the access point configuration of the network that the robot is broadcastingsee <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/connection/ap/config/get/response/{key}": { - "subscribe": { - "summary": "response: Get access point configuration", - "description": "Response about the access point that the robot is broadcasting\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "ssid": { - "type": "string" - }, - "password": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "APConfig", - "examples": [ - { - "payload": { - "enabled": true, - "ssid": "ZoraBotsHotspot", - "password": "hotspot_123" - } - }, - { - "payload": { - "enabled": false, - "ssid": "ZoraBotsHotspot", - "password": "hotspot_123", - "adapterName": "teth1" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/ap/config/set": { - "publish": { - "summary": "Set access point configuration", - "description": "Set the access point configuration of the network that the robot is broadcasting.see <> for response\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "ssid": { - "type": "string" - }, - "password": { - "type": "string" - }, - "adapterName": { - "type": "string" - } - } - }, - "name": "APConfig", - "examples": [ - { - "payload": { - "enabled": true, - "ssid": "ZoraBotsHotspot", - "password": "hotspot_123" - } - }, - { - "payload": { - "enabled": false, - "ssid": "ZoraBotsHotspot", - "password": "hotspot_123", - "adapterName": "teth1" - } - } - ] - } - } - }, - "zbos/connection/ap/config/set/response/{key}": { - "subscribe": { - "summary": "response: Set access point configuration", - "description": "A (json) message is published when saving the access point configuration was successful or not\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string" - } - } - }, - "name": "ConnectionResponse", - "examples": [ - { - "payload": { - "success": true, - "message": "ZoraBotsNetwork" - } - }, - { - "payload": { - "success": true, - "message": "" - } - }, - { - "payload": { - "success": false, - "message": "INVALID_CREDENTIALS" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/connection/ap/enable/event": { - "subscribe": { - "summary": "event: Access point enabled", - "description": "Triggered when the access point/hotspot is turned on\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/connection/ap/disable/event": { - "subscribe": { - "summary": "event: Access point disabled", - "description": "Triggered when the access point/hotspot is turned off\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/connection/usb/config/start": { - "publish": { - "summary": "Start connecting to a wifi config", - "description": "Look for a wifi config on the robot and attempt to connect to it\n", - "tags": [ - { - "name": "Connection", - "description": "All connection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/diagnostics/chassis/get": { - "publish": { - "summary": "Get diagnostics for chassis", - "description": "see <> for response\n", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/diagnostics/chassis/event": { - "subscribe": { - "summary": "event: Chassis state changed", - "description": "An event will be published when there is a problem detected with a motor or motor controller.\n", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "partId": { - "type": "string", - "description": "Name of the part" - }, - "partType": { - "type": "object", - "description": "Type of the part", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MOTOR", - "MOTOR_CONTROLLER", - "SERVO", - "SERVO_CONTROLLER", - "CPU", - "MEMORY", - "LIDAR", - "POWER_BOARD", - "BATTERY" - ] - }, - "info": { - "type": "object", - "properties": { - "translationKey": { - "type": "string", - "description": "status code" - }, - "message": { - "type": "string", - "description": "status message" - } - } - }, - "temperature": { - "type": "string", - "description": "optional, depending on robot" - } - } - }, - "name": "DiagnosticState", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/diagnostics/chassis/response/{key}": { - "subscribe": { - "summary": "response: Diagnostics chassis", - "description": "", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "partId": { - "type": "string", - "description": "Name of the part" - }, - "partType": { - "type": "object", - "description": "Type of the part", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MOTOR", - "MOTOR_CONTROLLER", - "SERVO", - "SERVO_CONTROLLER", - "CPU", - "MEMORY", - "LIDAR", - "POWER_BOARD", - "BATTERY" - ] - }, - "info": { - "type": "object", - "properties": { - "translationKey": { - "type": "string", - "description": "status code" - }, - "message": { - "type": "string", - "description": "status message" - } - } - }, - "temperature": { - "type": "string", - "description": "optional, depending on robot" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": {} - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/diagnostics/servos/get": { - "publish": { - "summary": "Get diagnostics for servos", - "description": "see <> for response\n", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/diagnostics/servos/event": { - "subscribe": { - "summary": "event: Servo state changed", - "description": "An event will be published when there is a problem detected with a servo.\n", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "partId": { - "type": "string", - "description": "Name of the part" - }, - "partType": { - "type": "object", - "description": "Type of the part", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MOTOR", - "MOTOR_CONTROLLER", - "SERVO", - "SERVO_CONTROLLER", - "CPU", - "MEMORY", - "LIDAR", - "POWER_BOARD", - "BATTERY" - ] - }, - "info": { - "type": "object", - "properties": { - "translationKey": { - "type": "string", - "description": "status code" - }, - "message": { - "type": "string", - "description": "status message" - } - } - }, - "temperature": { - "type": "string", - "description": "optional, depending on robot" - } - } - }, - "name": "DiagnosticState", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/diagnostics/servos/response/{key}": { - "subscribe": { - "summary": "response: Diagnostics servos", - "description": "", - "tags": [ - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "partId": { - "type": "string", - "description": "Name of the part" - }, - "partType": { - "type": "object", - "description": "Type of the part", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MOTOR", - "MOTOR_CONTROLLER", - "SERVO", - "SERVO_CONTROLLER", - "CPU", - "MEMORY", - "LIDAR", - "POWER_BOARD", - "BATTERY" - ] - }, - "info": { - "type": "object", - "properties": { - "translationKey": { - "type": "string", - "description": "status code" - }, - "message": { - "type": "string", - "description": "status message" - } - } - }, - "temperature": { - "type": "string", - "description": "optional, depending on robot" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": {} - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/domotica/get/settings": { - "publish": { - "summary": "Get settings", - "description": "see <> for response\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/domotica/get/settings/response/{key}": { - "subscribe": { - "summary": "response: Get settings", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "login": { - "type": "string" - }, - "password": { - "type": "string" - }, - "ip": { - "type": "string" - } - } - }, - "name": "Settings", - "examples": [ - { - "payload": { - "brand": "creadomotics", - "login": "admin", - "password": "admin", - "ip": "192.168.0.123" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/domotica/set/setting": { - "publish": { - "summary": "Set settings", - "description": "Sets login, password and ip of a domotics center. Automatically replaces settings from the same brand. Settings are saved to the sd card. If no file exists, it is automatically created.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "login": { - "type": "string" - }, - "password": { - "type": "string" - }, - "ip": { - "type": "string" - } - } - }, - "name": "Settings", - "examples": [ - { - "payload": { - "brand": "creadomotics", - "login": "admin", - "password": "admin", - "ip": "192.168.0.123" - } - } - ] - } - } - }, - "zbos/domotica/delete/settings/all": { - "publish": { - "summary": "Delete all settings", - "description": "Deletes all the plugin settings/configs from the device.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/domotica/get/status": { - "publish": { - "summary": "Get status", - "description": "see <> for response\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/domotica/get/status/response/{key}": { - "subscribe": { - "summary": "response: Get status", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "state": { - "type": "object", - "description": "Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "INITIALIZING", - "CONNECTING", - "CONNECTION_FAILED", - "CONNECTION_SUCCEEDED", - "NOT_CONFIGURED" - ] - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "brand": "creadomotics", - "state": "CONNECTION_FAILED" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/domotica/get/devices": { - "publish": { - "summary": "Get devices", - "description": "see <> for response\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/domotica/get/devices/response/{key}": { - "subscribe": { - "summary": "response: Get devices", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - }, - "brand": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "room": "kitchen", - "tags": [ - "string", - "bar", - "kitchen" - ], - "type": "dimmer", - "brand": "creadomotics", - "validDevice": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/domotica/add/device": { - "publish": { - "summary": "Add device", - "description": "Automatically removes device from same brand with same id. devices are saved to the sd card. If no file exists, it is automatically created.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - }, - "brand": { - "type": "string" - } - } - }, - "name": "DomoticaDevice", - "examples": [ - { - "payload": { - "id": "string", - "room": "kitchen", - "tags": [ - "string", - "bar", - "kitchen" - ], - "type": "dimmer", - "brand": "creadomotics", - "validDevice": true - } - } - ] - } - } - }, - "zbos/domotica/delete/device": { - "publish": { - "summary": "Delete device", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - }, - "brand": { - "type": "string" - } - } - }, - "name": "DomoticaDevice", - "examples": [ - { - "payload": { - "id": "string", - "validDevice": false - } - } - ] - } - } - }, - "zbos/domotica/delete/devices/all": { - "publish": { - "summary": "Delete all devices", - "description": "Deletes all locally configured devices.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/domotica/get/rooms": { - "publish": { - "summary": "Get rooms", - "description": "see <> for response\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/domotica/get/rooms/response/{key}": { - "subscribe": { - "summary": "response: Get rooms", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "devices": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - }, - "brand": { - "type": "string" - } - } - } - } - } - }, - "name": "Room", - "examples": [ - { - "payload": {} - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/domotica/set/notifications": { - "publish": { - "summary": "Enable notifications on device state changes", - "description": "To get notifications for all device types, pass \"all\" as a device type.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/domotica/event": { - "subscribe": { - "summary": "event: Domotica state changes", - "description": "", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "state": { - "type": "object", - "properties": { - "value": { - "type": "object", - "properties": {} - }, - "optionalValue": { - "type": "object", - "properties": {} - }, - "unit": { - "type": "string" - } - } - }, - "type": { - "type": "string" - }, - "id": { - "type": "string" - } - } - }, - "name": "DeviceState", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "state": { - "value": "ON" - }, - "type": "motion", - "id": "string" - } - } - ] - } - } - }, - "zbos/domotica/device/event": { - "subscribe": { - "summary": "event: Domotica device", - "description": "Domotica device state changes trigger this event. Has no payload, state is in the topic itself.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/domotica/plugin/event": { - "subscribe": { - "summary": "event: Domotica plugin", - "description": "Plugin state changes (such as connectivity changes) trigger this event.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "brand": { - "type": "string" - }, - "state": { - "type": "object", - "description": "Can be: INITIALIZING, CONNECTING, CONNECTION_FAILED, CONNECTION_SUCCEEDED", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "INITIALIZING", - "CONNECTING", - "CONNECTION_FAILED", - "CONNECTION_SUCCEEDED", - "NOT_CONFIGURED" - ] - } - } - }, - "name": "PluginState", - "examples": [ - { - "payload": { - "brand": "creadomotics", - "state": "INITIALIZING" - } - } - ] - } - } - }, - "zbos/domotica/set/device/bool": { - "publish": { - "summary": "Set device", - "description": "All devices in given room of given type including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The device type. Currently supported types are: light, dimmer, switch, plug, door, shutter, speaker." - }, - "state": { - "type": "boolean", - "description": "True for on/open/..., false for off/closed/..." - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetDeviceOptions", - "examples": [ - { - "payload": { - "type": "string", - "state": true - } - } - ] - } - } - }, - "zbos/domotica/get/light": { - "publish": { - "summary": "Get light", - "description": "All lights in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/light": { - "publish": { - "summary": "Set light", - "description": "All lights in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "state": { - "type": "boolean", - "description": "True for on, false for off" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetBooleanOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "state": true - } - } - ] - } - } - }, - "zbos/domotica/get/dimmer": { - "publish": { - "summary": "Get dimmer", - "description": "All dimmers in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/dimmer": { - "publish": { - "summary": "Set dimmer", - "description": "All dimmers in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "value": { - "type": "integer", - "description": "Value between 0 and 100 (percentage). To turn off, give value zero" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetIntOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "value": 100 - } - } - ] - } - } - }, - "zbos/domotica/get/switch": { - "publish": { - "summary": "Get switch", - "description": "All switches in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/switch": { - "publish": { - "summary": "Set switch", - "description": "All switches in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "state": { - "type": "boolean", - "description": "True for on, false for off" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetBooleanOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "state": true - } - } - ] - } - } - }, - "zbos/domotica/get/door": { - "publish": { - "summary": "Get door", - "description": "All doors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/door": { - "publish": { - "summary": "Set door", - "description": "All doors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "state": { - "type": "boolean", - "description": "True for on, false for off" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetBooleanOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "state": true - } - } - ] - } - } - }, - "zbos/domotica/get/shutter": { - "publish": { - "summary": "Get Shutter", - "description": "All shutters in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/shutter": { - "publish": { - "summary": "Set shutter", - "description": "All shutters in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "state": { - "type": "boolean", - "description": "True for on, false for off" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetBooleanOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "state": true - } - } - ] - } - } - }, - "zbos/domotica/get/speaker": { - "publish": { - "summary": "Get speaker", - "description": "All speakers in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/set/speaker": { - "publish": { - "summary": "Set speaker", - "description": "All speakers in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "command": { - "type": "string", - "description": "Supported commands: play, pause, mute, unmute, set volume, increase volume, decrease volume, next song, previous song" - }, - "value": { - "type": "integer", - "description": "Optional. Only used for 'set volume' command. Value between 0 and 100 (percentage)" - }, - "room": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaSetSpeakerOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ], - "command": "play", - "value": 70 - } - } - ] - } - } - }, - "zbos/domotica/get/doorsensor": { - "publish": { - "summary": "Get doorsensor", - "description": "All doorsensors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/get/motionsensor": { - "publish": { - "summary": "Get motionsensor", - "description": "All motionsensors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/get/floodsensor": { - "publish": { - "summary": "Get floodsensor", - "description": "All floodsensors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/get/lightsensor": { - "publish": { - "summary": "Get lightsensor", - "description": "All lightsensors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/get/temperature": { - "publish": { - "summary": "Get temperature", - "description": "All temperature sensors in given room including all given tags will be adressed.\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string", - "description": "Optional" - }, - "tags": { - "type": "array", - "description": "Optional", - "items": { - "type": "string" - } - } - } - }, - "name": "DomoticaGetOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "tags": [ - "bar", - "kitchen" - ] - } - } - ] - } - } - }, - "zbos/domotica/play/scene": { - "publish": { - "summary": "Set scene", - "description": "All scenes in given room will be adressed. Use scene property to specify specific scene. Scene names can be found in the tags of scene objects.see <> for response\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "room": { - "type": "string" - }, - "scene": { - "type": "string", - "description": "Optional" - } - } - }, - "name": "DomoticaPlaySceneOptions", - "examples": [ - { - "payload": { - "room": "kitchen", - "scene": "demo scene" - } - } - ] - } - } - }, - "zbos/domotica/response/{key}": { - "subscribe": { - "summary": "Domotics response", - "description": "Response for the various device getters: get light, get dimmer, etc\n", - "tags": [ - { - "name": "Domotics", - "description": "All domotics related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": {} - }, - "name": "Any" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/facetracking/start": { - "publish": { - "summary": "Start continuous facetracking, see <> for events", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/facetracking/stop": { - "publish": { - "summary": "Stop continuous facetracking", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/facetracking/detected/faces": { - "subscribe": { - "summary": "event: Detected faces", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "uuid": "some uuid", - "name": "some name", - "role": "some description" - } - }, - { - "payload": { - "name": "unknown" - } - } - ] - } - } - }, - "zbos/facetracking/response": { - "subscribe": { - "summary": "response: Face", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "uuid": "some uuid", - "name": "some name", - "role": "some description" - } - }, - { - "payload": { - "name": "unknown" - } - } - ] - } - } - }, - "zbos/facetracking/add_request": { - "publish": { - "summary": "Add a person", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "role": { - "type": "string", - "description": "Optional, a descriptor for this person" - }, - "ImageString": { - "type": "string", - "description": "Optional, if this has a value (in base64) the given image will be used. Otherwise, a stream will be started to find a new person" - }, - "options": { - "type": "object", - "description": "Optional, the global options will be used if no value is given", - "properties": { - "mode": { - "type": "object", - "description": "How closely the person must match", - "properties": { - "euclideanThreshold": { - "type": "number" - }, - "cosineThreshold": { - "type": "number" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "LOOSE", - "NORMAL", - "STRICT" - ] - }, - "tries": { - "type": "integer", - "description": "How many times to check for a person before giving up" - }, - "timeout": { - "type": "integer", - "description": "How long to look for a person before giving up" - } - } - } - } - }, - "name": "PersonAddRequest", - "examples": [ - { - "payload": { - "name": "some name", - "role": "some description" - } - }, - { - "payload": { - "name": "another name", - "options": { - "mode": "STRICT", - "tries": 5, - "timeout": 60 - }, - "role": "another description", - "ImageString": "some base64 image" - } - } - ] - } - } - }, - "zbos/facetracking/add_response": { - "subscribe": { - "summary": "response: Add a person", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/facetracking/update_request": { - "publish": { - "summary": "Add a new face to an existing person", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/facetracking/update_response": { - "subscribe": { - "summary": "response: Add a new face to an existing person", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/facetracking/update_person_request": { - "publish": { - "summary": "Update a person", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - }, - "name": "Person", - "examples": [ - { - "payload": { - "uuid": "some uuid", - "name": "some new name", - "role": "some new description" - } - } - ] - } - } - }, - "zbos/facetracking/update_person_response": { - "subscribe": { - "summary": "response: Update a person", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/facetracking/delete_request": { - "publish": { - "summary": "Delete a person", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - }, - "name": "Person", - "examples": [ - { - "payload": { - "uuid": "some uuid" - } - } - ] - } - } - }, - "zbos/facetracking/delete_response": { - "subscribe": { - "summary": "response: Delete a person", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/facetracking/name_request": { - "publish": { - "summary": "Request the list of registered persons", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/facetracking/name_response": { - "subscribe": { - "summary": "response: Request the list of registered persons", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - } - }, - "name": "Array" - } - } - }, - "zbos/facetracking/persondata_request": { - "publish": { - "summary": "Request all data of a person", - "description": "see <> for response\n", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - } - } - }, - "name": "Person", - "examples": [ - { - "payload": { - "uuid": "some uuid" - } - } - ] - } - } - }, - "zbos/facetracking/persondata_response": { - "subscribe": { - "summary": "response: Request all data of a person", - "description": "", - "tags": [ - { - "name": "Face tracking", - "description": "All face tracking related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "uuid": { - "type": "string" - }, - "name": { - "type": "string" - }, - "role": { - "type": "string" - }, - "image": { - "type": "string", - "description": "A base64 image of this person" - } - } - }, - "name": "PersonGetResponse", - "examples": [ - { - "payload": { - "uuid": "some uuid", - "name": "some name", - "image": "some base64 image", - "role": "some description" - } - } - ] - } - } - }, - "zbos/kiosk/resume/event": { - "subscribe": { - "summary": "event: Kiosk is active", - "description": "Fired when kiosk is active after being moved to the background\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/apps/home": { - "publish": { - "summary": "Open home screen", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/apps/start": { - "publish": { - "summary": "Start application remotely on Kiosk", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "appName": { - "type": "string" - }, - "extras": { - "type": "object" - } - } - }, - "name": "ApplicationStartRequest", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/remote/kiosk/apps/get": { - "publish": { - "summary": "Get installed applications on Kiosk", - "description": "Request a list of all installed & listed applications from the Kiosksee <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/remote/kiosk/apps/response/{key}": { - "subscribe": { - "summary": "response: Get installed applications on Kiosk", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "app_name": { - "type": "string" - }, - "package_name": { - "type": "string" - }, - "image_base64": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "app_name": "string", - "package_name": "string", - "image_base64": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/apps/all/get": { - "publish": { - "summary": "Get installed applications on Kiosk", - "description": "Request a list of all installed & listed applications from the Kiosksee <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/remote/kiosk/apps/all/response/{key}": { - "subscribe": { - "summary": "response: Get installed applications on Kiosk", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "app_name": { - "type": "string" - }, - "package_name": { - "type": "string" - }, - "image_base64": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "app_name": "string", - "package_name": "string", - "image_base64": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/{type}/show": { - "publish": { - "summary": "Show multimedia", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "type": { - "description": "Type of multimedia", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/{type}/show/response/{key}": { - "subscribe": { - "summary": "response: Show multimedia", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "type": { - "description": "Type of multimedia", - "schema": { - "type": "string" - } - }, - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/input/show": { - "publish": { - "summary": "Show input prompt", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "question": { - "type": "string" - }, - "textType": { - "type": "string" - }, - "confirmText": { - "type": "string" - } - } - }, - "name": "InputBlock", - "examples": [ - { - "payload": { - "question": "string" - } - } - ] - } - } - }, - "zbos/remote/kiosk/input/show/response/{key}": { - "subscribe": { - "summary": "response: Show input prompt", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "input": { - "type": "string" - } - } - }, - "name": "InputResponse", - "examples": [ - { - "payload": { - "input": "input" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/print/show": { - "publish": { - "summary": "Show print dialog", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "file_path": { - "type": "string", - "description": "Required. The path to a PDF file to print." - }, - "media_size": { - "type": "string", - "description": "Optional. The format of the paper to be printed, defaults to 'Letter'" - }, - "printer_name": { - "type": "string", - "description": "Optional, only used when auto print is enabled. The name of or part of the name of a printer, defaults to first available printer" - }, - "auto_print": { - "type": "boolean", - "description": "Optional. Whether to use the accessibility service to automatically print to the desired printer without user input" - } - } - }, - "name": "PrintOptions", - "examples": [ - { - "payload": { - "key": "some_key", - "file_path": "/sdcard/zbos_media_library/dummy.pdf", - "media_size": "ISO_A4", - "printer_name": "HP LaserJet Pro", - "auto_print": true - } - } - ] - } - } - }, - "zbos/remote/kiosk/print/show/response/{key}": { - "subscribe": { - "summary": "response: Show print dialog", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/text/overlay/show": { - "publish": { - "summary": "Show text overlay", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "text": { - "type": "string" - }, - "textColor": { - "type": "string" - }, - "backgroundColor": { - "type": "string" - } - } - }, - "name": "TextOverlayOptions", - "examples": [ - { - "payload": { - "key": "some_key", - "text": "Hello George, nice to meet you!", - "textColor": "#00FF00", - "backgroundColor": "#FF0000" - } - } - ] - } - } - }, - "zbos/remote/kiosk/text/overlay/show/response/{key}": { - "subscribe": { - "summary": "response: Show text overlay", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/text/overlay/hide": { - "publish": { - "summary": "Hide text overlay", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/remote/kiosk/text/overlay/hide/response/{key}": { - "subscribe": { - "summary": "response: Hide text overlay", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/microphone/show": { - "publish": { - "summary": "Show microphone in composition", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/multimedia/image/show": { - "publish": { - "summary": "Show image", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "style": { - "type": "object", - "properties": { - "backgroundColor": { - "type": "string" - } - } - }, - "url": { - "type": "string" - } - } - }, - "name": "Image", - "examples": [ - { - "payload": { - "id": "string", - "style": { - "backgroundColor": "string" - }, - "url": "string" - } - } - ] - } - } - }, - "zbos/remote/kiosk/multimedia/image/show/response/{key}": { - "subscribe": { - "summary": "response: Show image", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "path": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "style": { - "type": "object", - "properties": { - "backgroundColor": { - "type": "string" - } - } - }, - "url": { - "type": "string" - } - } - }, - "name": "Image", - "examples": [ - { - "payload": { - "id": "string", - "style": { - "backgroundColor": "string" - }, - "url": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/image/stop": { - "publish": { - "summary": "Stop showing image", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/multimedia/image/{filename}/end": { - "subscribe": { - "summary": "event: Image ended", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "filename": { - "description": "Name of the file", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/video/show": { - "publish": { - "summary": "Show video", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repeat": { - "type": "boolean" - }, - "audioUrl": { - "type": "string" - }, - "videoOnly": { - "type": "boolean" - }, - "showControls": { - "type": "boolean" - } - } - }, - "name": "Video", - "examples": [ - { - "payload": { - "id": "string", - "url": "string", - "repeat": true, - "audioUrl": "string", - "videoOnly": false, - "showControls": true, - "remoteVideo": false - } - } - ] - } - } - }, - "zbos/remote/kiosk/multimedia/video/show/response/{key}": { - "subscribe": { - "summary": "response: Show video", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "repeat": { - "type": "boolean" - }, - "audioUrl": { - "type": "string" - }, - "videoOnly": { - "type": "boolean" - }, - "showControls": { - "type": "boolean" - } - } - }, - "name": "Video", - "examples": [ - { - "payload": { - "id": "string", - "url": "string", - "repeat": true, - "audioUrl": "string", - "videoOnly": false, - "showControls": true, - "remoteVideo": false - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/video/stop": { - "publish": { - "summary": "Stop video", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/multimedia/video/{filename}/end": { - "subscribe": { - "summary": "event: Video ended", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "filename": { - "description": "Name of the file", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/multimedia/page/show": { - "publish": { - "summary": "Show page in kiosk", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "blocking": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "name": "OpenBrowserBlock", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/remote/kiosk/multimedia/page/show/response/{key}": { - "subscribe": { - "summary": "response: Show page in kiosk", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "blocking": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "url": { - "type": "string" - } - } - }, - "name": "OpenBrowserBlock", - "examples": [ - { - "payload": {} - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/remote/kiosk/action/start": { - "publish": { - "summary": "Start action", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": {} - }, - "name": "Action" - } - } - }, - "zbos/remote/kiosk/settings/lock/state/get": { - "publish": { - "summary": "Get current lockstate", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/remote/kiosk/settings/lock/state/response": { - "subscribe": { - "summary": "response: Get current lockstate", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "isLocked": { - "type": "boolean" - }, - "isPincodeSet": { - "type": "boolean" - } - } - }, - "name": "LockStatus", - "examples": [ - { - "payload": { - "locked": true, - "pincodeSet": false - } - } - ] - } - } - }, - "zbos/remote/kiosk/settings/unlock": { - "publish": { - "summary": "Unlock settings page", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/settings/lock": { - "publish": { - "summary": "Lock settings page", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/settings/lock/event": { - "subscribe": { - "summary": "response: Lock settings page", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "response": { - "type": "string" - }, - "success": { - "type": "boolean" - } - } - }, - "name": "LockResponse", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/remote/kiosk/settings/unlock/event": { - "subscribe": { - "summary": "response: Unlock settings page", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "response": { - "type": "string" - }, - "success": { - "type": "boolean" - } - } - }, - "name": "LockResponse", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/remote/kiosk/settings/pincode/change/event": { - "subscribe": { - "summary": "response: Change current pincode", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "response": { - "type": "string" - }, - "success": { - "type": "boolean" - } - } - }, - "name": "LockResponse", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/remote/kiosk/settings/pincode/remove": { - "publish": { - "summary": "Remove current pincode", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/remote/kiosk/settings/pincode/remove/event": { - "subscribe": { - "summary": "response: Remove current pincode", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "response": { - "type": "string" - }, - "success": { - "type": "boolean" - } - } - }, - "name": "LockResponse", - "examples": [ - { - "payload": {} - } - ] - } - } - }, - "zbos/kiosk/datasource/get/all": { - "publish": { - "summary": "Get all datasources", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/kiosk/datasource/get/all/response/{key}": { - "subscribe": { - "summary": "response: Get all datasources", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/datasource/get": { - "publish": { - "summary": "Get specific datasources", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleDataSource", - "examples": [ - { - "payload": { - "id": "string", - "name": "string" - } - } - ] - } - } - }, - "zbos/kiosk/datasource/get/response/{key}": { - "subscribe": { - "summary": "response: Get specific datasources", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/datasource/current/get": { - "publish": { - "summary": "Get active datasources", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/kiosk/datasource/current/get/response/{key}": { - "subscribe": { - "summary": "response: Get active datasources", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/datasource/set": { - "publish": { - "summary": "Set current Kiosk datasources", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "name": "ChangeDatasourceRequest", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/kiosk/datasource/save": { - "publish": { - "summary": "Save or add a datasource", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleDataSource", - "examples": [ - { - "payload": { - "id": "string", - "name": "String" - } - } - ] - } - } - }, - "zbos/kiosk/datasource/save/event/{kiosk_id}": { - "subscribe": { - "summary": "response: Get active datasources", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "kiosk_id": { - "description": "ID of kiosk", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/datasource/delete": { - "publish": { - "summary": "Delete a datasource", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleDataSource", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/kiosk/datasource/delete/event/{kiosk_id}": { - "subscribe": { - "summary": "response: Delete a datasource", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "kiosk_id": { - "description": "ID of kiosk", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/composition/pin/lock": { - "publish": { - "summary": "Pin a composition", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - } - } - }, - "name": "PinnedComposition", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/kiosk/composition/pin/unlock": { - "publish": { - "summary": "Unpin a composition", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/kiosk/composition/pin/get": { - "publish": { - "summary": "Request the current pin status & pinned composition.", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/kiosk/composition/pin/get/response/{key}": { - "subscribe": { - "summary": "response: pin status & pinned composition", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "isPinned": { - "type": "boolean" - }, - "id": { - "type": "string" - } - } - }, - "name": "PinnedCompositionState", - "examples": [ - { - "payload": { - "id": "string", - "pinned": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/kiosk/app/pin/lock": { - "publish": { - "summary": "Pin an app, if installed", - "description": "A locked app will be launched immediately when the kiosk opens.\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "packageName": { - "type": "string" - } - } - }, - "name": "PinnedApplication", - "examples": [ - { - "payload": { - "packageName": "string" - } - } - ] - } - } - }, - "zbos/kiosk/app/pin/unlock": { - "publish": { - "summary": "Unpin an app.", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/kiosk/app/pin/get": { - "publish": { - "summary": "Request the current pin status & pinned app.", - "description": "see <> for response\n", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/kiosk/app/pin/get/response/{key}": { - "subscribe": { - "summary": "response: pin status & pinned app", - "description": "", - "tags": [ - { - "name": "Kiosk", - "description": "All kiosk related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "isPinned": { - "type": "boolean" - }, - "packageName": { - "type": "string" - } - } - }, - "name": "PinnedApplicationState", - "examples": [ - { - "payload": { - "packageName": "string", - "pinned": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/leds/chestlight/set": { - "publish": { - "summary": "Set chest light color", - "description": "", - "tags": [ - { - "name": "Leds", - "description": "All leds related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "part": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "CHEST", - "MOUTH", - "EYES", - "HEAD", - "SPEECH" - ] - }, - "color": { - "type": "string", - "description": "The format is \"#FF0000\" (red)" - }, - "breathe": { - "type": "boolean" - }, - "breathDuration": { - "type": "integer" - }, - "duration": { - "type": "integer" - } - } - }, - "name": "LedOptions", - "examples": [ - { - "payload": { - "part": "CHEST", - "color": "#ff077e", - "breathDuration": 1500, - "duration": -1 - } - } - ] - } - } - }, - "zbos/media/library/list": { - "publish": { - "summary": "List all media libraries", - "description": "[DEPRECATED]\nPlease use <>\n\n", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/library/list/event": { - "subscribe": { - "summary": "event: Listing all media libraries", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/library/list/get": { - "publish": { - "summary": "Get a list of media items", - "description": "see <> for response\n", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "filters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field to check on. Note that the field should be camelCase, not snake_case" - }, - "value": { - "type": "string", - "description": "Value to check on. For numbers you should use 'min' and 'max'." - }, - "min": { - "type": "number", - "description": "Minimum value, only usable for number fields" - }, - "max": { - "type": "number", - "description": "Maximum value, only usable for number fields" - }, - "direction": { - "type": "object", - "description": "Direction to sort on.\nCan be 'asc' or 'desc'.\nThe default direction is 'asc'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "asc", - "desc" - ] - }, - "operator": { - "type": "object", - "description": "Operator for either the child filters, or this filter object itself.\nCan be 'and', 'or' or 'not'.\nDefault is 'and'.\nThe root operator is always 'and'", - "properties": { - "alternateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "and", - "or", - "not" - ] - }, - "match_type": { - "type": "object", - "description": "Match type for string values.\nCan be 'exact', 'contains', 'starts_with', 'ends_with'.\nThe default match_type is 'contains'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "exact", - "contains", - "starts_with", - "ends_with" - ] - }, - "filters": { - "type": "array", - "description": "Filters on which the operator will be applied.\nIf there are no child filters, the operator will be applied to the filter object itself.", - "items": { - "type": "object" - } - }, - "field_filters": { - "type": "array", - "description": "Filters to apply on the child fields of the field.\nWill only work if the field is an object, array/list or map.", - "items": { - "type": "object" - } - } - } - } - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field to check on. Note that the field should be camelCase, not snake_case" - }, - "value": { - "type": "string", - "description": "Value to check on. For numbers you should use 'min' and 'max'." - }, - "min": { - "type": "number", - "description": "Minimum value, only usable for number fields" - }, - "max": { - "type": "number", - "description": "Maximum value, only usable for number fields" - }, - "direction": { - "type": "object", - "description": "Direction to sort on.\nCan be 'asc' or 'desc'.\nThe default direction is 'asc'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "asc", - "desc" - ] - }, - "operator": { - "type": "object", - "description": "Operator for either the child filters, or this filter object itself.\nCan be 'and', 'or' or 'not'.\nDefault is 'and'.\nThe root operator is always 'and'", - "properties": { - "alternateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "and", - "or", - "not" - ] - }, - "match_type": { - "type": "object", - "description": "Match type for string values.\nCan be 'exact', 'contains', 'starts_with', 'ends_with'.\nThe default match_type is 'contains'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "exact", - "contains", - "starts_with", - "ends_with" - ] - }, - "filters": { - "type": "array", - "description": "Filters on which the operator will be applied.\nIf there are no child filters, the operator will be applied to the filter object itself.", - "items": { - "type": "object" - } - }, - "field_filters": { - "type": "array", - "description": "Filters to apply on the child fields of the field.\nWill only work if the field is an object, array/list or map.", - "items": { - "type": "object" - } - } - } - } - } - } - }, - "name": "FilteringRequest", - "examples": [ - { - "payload": { - "key": "Test123", - "limit": 50, - "offset": 10, - "filters": [ - { - "operator": "or", - "match_type": "contains" - }, - { - "field": "type", - "value": "image", - "operator": "and", - "match_type": "contains" - }, - { - "field": "date", - "operator": "and", - "match_type": "contains" - } - ], - "sort": [ - { - "field": "extension", - "operator": "and", - "match_type": "contains" - }, - { - "field": "name", - "operator": "and", - "match_type": "contains" - } - ] - } - } - ] - } - } - }, - "zbos/media/library/list/response/{key}": { - "subscribe": { - "summary": "response: Get a list of media items", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fileId": { - "type": "string" - }, - "path": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "extension": { - "type": "string" - }, - "type": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "downloadPath": { - "type": "string" - }, - "previewPath": { - "type": "string" - }, - "thumbnailPath": { - "type": "string" - }, - "checksum": { - "type": "string" - }, - "cloudFileId": { - "type": "string" - }, - "size": { - "type": "number" - }, - "modifiedAt": { - "type": "number" - }, - "isDefaultAsset": { - "type": "boolean" - }, - "fullPath": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": [ - { - "fileId": "string", - "path": "string", - "fileName": "string", - "extension": "string", - "type": "string", - "mimeType": "string", - "downloadPath": "string", - "previewPath": "string", - "thumbnailPath": "string", - "checksum": "string", - "cloudFileId": "string", - "size": 0, - "modifiedAt": 0, - "defaultAsset": false - } - ] - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/media/library/event": { - "subscribe": { - "summary": "Library item changed event", - "description": "This event is published when an item in the media library list changes\n", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/sync/device/get": { - "publish": { - "summary": "Get media sync devices", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/sync/device/event": { - "subscribe": { - "summary": "event: Media sync devices", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/media/export/get": { - "publish": { - "summary": "Get all media exports", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "clientId": { - "type": "string" - }, - "compositionId": { - "type": "string" - }, - "compositionName": { - "type": "string" - }, - "mediaPaths": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "ExportRequestDto", - "examples": [ - { - "payload": { - "clientId": "string", - "compositionId": "string", - "compositionName": "string", - "mediaPaths": [ - "string" - ] - } - } - ] - } - } - }, - "zbos/media/export/event": { - "subscribe": { - "summary": "event: All media exported", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "clientId": { - "type": "string" - }, - "compositionId": { - "type": "string" - }, - "compositionName": { - "type": "string" - }, - "mediaPaths": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "name": "ExportRequestDto", - "examples": [ - { - "payload": { - "clientId": "string", - "compositionId": "string", - "compositionName": "string", - "mediaPaths": [ - "string" - ] - } - } - ] - } - } - }, - "zbos/media/apk/install": { - "publish": { - "summary": "Install APK", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/media/delete/all": { - "publish": { - "summary": "Delete all media", - "description": "", - "tags": [ - { - "name": "Media", - "description": "All media related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/monitoring/event/{source}/{type}": { - "subscribe": { - "summary": "Monitoring event", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Mandatory. A unique ID for the event" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. The time at which the event occurred" - }, - "type": { - "type": "string", - "description": "Mandatory. The type of event this is, no dots allowed" - }, - "source": { - "type": "string", - "description": "Mandatory. What device produced this event, no dots allowed" - }, - "value": { - "type": "string", - "description": "Optional. A value relating to the event such as a temperature" - }, - "data": { - "type": "object", - "description": "Optional. Extra data related to the event" - }, - "unit": { - "type": "string", - "description": "Optional. The type of unit the value is expressed in such as °C" - }, - "alarms": { - "type": "array", - "description": "Optional. Alarms attached to this event", - "items": { - "type": "object", - "properties": { - "type": { - "type": "object", - "description": "Mandatory. The type of alarm", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "ItemOmission", - "ItemCommission", - "ServiceOmission", - "ServiceCommission", - "TransientServiceOmission", - "TransientServiceCommission", - "EarlyServiceOmission", - "LateServiceCommission", - "EarlyServiceStart", - "LateServiceStart", - "BoundedOmissionInterval", - "UndetectableValueError", - "BelowRange", - "AboveRange", - "BoundedValueChange", - "StuckValue", - "OutOfBounds", - "OutOfOrder", - "OutOfCalibration", - "EarlyDelivery", - "LateDelivery", - "HighRate", - "LowRate", - "RateJitter", - "EarlyService", - "DelayedService", - "SymmetricReplicationError", - "AsymmetricApproximateValue", - "AsymmetricExactValue", - "AsymmetricItemOmission", - "AsymmetricServiceOmission", - "AsymmetricTiming", - "ReadWriteRace", - "WriteWriteRace", - "Deadlock", - "Starvation", - "AuthorizationError", - "AuthenticationError" - ] - }, - "severity": { - "type": "integer", - "description": "Mandatory. How critical the alarm is" - }, - "persist": { - "type": "boolean", - "description": "Mandatory. If this is an ongoing alarm" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. When the alarm initially started" - } - } - } - } - } - }, - "name": "MonitoringEvent" - } - }, - "parameters": { - "source": { - "description": "Source of monitoring event", - "schema": { - "type": "string" - } - }, - "type": { - "description": "Type of monitoring event", - "schema": { - "type": "string" - } - } - } - }, - "zbos/monitoring/list/get": { - "publish": { - "summary": "Get monitoring events", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "limit": { - "type": "integer" - }, - "offset": { - "type": "integer" - }, - "filters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field to check on. Note that the field should be camelCase, not snake_case" - }, - "value": { - "type": "string", - "description": "Value to check on. For numbers you should use 'min' and 'max'." - }, - "min": { - "type": "number", - "description": "Minimum value, only usable for number fields" - }, - "max": { - "type": "number", - "description": "Maximum value, only usable for number fields" - }, - "direction": { - "type": "object", - "description": "Direction to sort on.\nCan be 'asc' or 'desc'.\nThe default direction is 'asc'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "asc", - "desc" - ] - }, - "operator": { - "type": "object", - "description": "Operator for either the child filters, or this filter object itself.\nCan be 'and', 'or' or 'not'.\nDefault is 'and'.\nThe root operator is always 'and'", - "properties": { - "alternateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "and", - "or", - "not" - ] - }, - "match_type": { - "type": "object", - "description": "Match type for string values.\nCan be 'exact', 'contains', 'starts_with', 'ends_with'.\nThe default match_type is 'contains'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "exact", - "contains", - "starts_with", - "ends_with" - ] - }, - "filters": { - "type": "array", - "description": "Filters on which the operator will be applied.\nIf there are no child filters, the operator will be applied to the filter object itself.", - "items": { - "type": "object" - } - }, - "field_filters": { - "type": "array", - "description": "Filters to apply on the child fields of the field.\nWill only work if the field is an object, array/list or map.", - "items": { - "type": "object" - } - } - } - } - }, - "sort": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field to check on. Note that the field should be camelCase, not snake_case" - }, - "value": { - "type": "string", - "description": "Value to check on. For numbers you should use 'min' and 'max'." - }, - "min": { - "type": "number", - "description": "Minimum value, only usable for number fields" - }, - "max": { - "type": "number", - "description": "Maximum value, only usable for number fields" - }, - "direction": { - "type": "object", - "description": "Direction to sort on.\nCan be 'asc' or 'desc'.\nThe default direction is 'asc'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "asc", - "desc" - ] - }, - "operator": { - "type": "object", - "description": "Operator for either the child filters, or this filter object itself.\nCan be 'and', 'or' or 'not'.\nDefault is 'and'.\nThe root operator is always 'and'", - "properties": { - "alternateNames": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "and", - "or", - "not" - ] - }, - "match_type": { - "type": "object", - "description": "Match type for string values.\nCan be 'exact', 'contains', 'starts_with', 'ends_with'.\nThe default match_type is 'contains'", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "exact", - "contains", - "starts_with", - "ends_with" - ] - }, - "filters": { - "type": "array", - "description": "Filters on which the operator will be applied.\nIf there are no child filters, the operator will be applied to the filter object itself.", - "items": { - "type": "object" - } - }, - "field_filters": { - "type": "array", - "description": "Filters to apply on the child fields of the field.\nWill only work if the field is an object, array/list or map.", - "items": { - "type": "object" - } - } - } - } - } - } - }, - "name": "FilteringRequest", - "examples": [ - { - "payload": { - "key": "Test123", - "limit": 50, - "offset": 10, - "filters": [ - { - "operator": "or", - "match_type": "contains" - }, - { - "field": "type", - "value": "image", - "operator": "and", - "match_type": "contains" - }, - { - "field": "date", - "operator": "and", - "match_type": "contains" - } - ], - "sort": [ - { - "field": "extension", - "operator": "and", - "match_type": "contains" - }, - { - "field": "name", - "operator": "and", - "match_type": "contains" - } - ] - } - } - ] - } - } - }, - "zbos/monitoring/list/get/response/{key}": { - "subscribe": { - "summary": "response: Get monitoring events", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Mandatory. A unique ID for the event" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. The time at which the event occurred" - }, - "type": { - "type": "string", - "description": "Mandatory. The type of event this is, no dots allowed" - }, - "source": { - "type": "string", - "description": "Mandatory. What device produced this event, no dots allowed" - }, - "value": { - "type": "string", - "description": "Optional. A value relating to the event such as a temperature" - }, - "data": { - "type": "object", - "description": "Optional. Extra data related to the event" - }, - "unit": { - "type": "string", - "description": "Optional. The type of unit the value is expressed in such as °C" - }, - "alarms": { - "type": "array", - "description": "Optional. Alarms attached to this event", - "items": { - "type": "object", - "properties": { - "type": { - "type": "object", - "description": "Mandatory. The type of alarm", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "ItemOmission", - "ItemCommission", - "ServiceOmission", - "ServiceCommission", - "TransientServiceOmission", - "TransientServiceCommission", - "EarlyServiceOmission", - "LateServiceCommission", - "EarlyServiceStart", - "LateServiceStart", - "BoundedOmissionInterval", - "UndetectableValueError", - "BelowRange", - "AboveRange", - "BoundedValueChange", - "StuckValue", - "OutOfBounds", - "OutOfOrder", - "OutOfCalibration", - "EarlyDelivery", - "LateDelivery", - "HighRate", - "LowRate", - "RateJitter", - "EarlyService", - "DelayedService", - "SymmetricReplicationError", - "AsymmetricApproximateValue", - "AsymmetricExactValue", - "AsymmetricItemOmission", - "AsymmetricServiceOmission", - "AsymmetricTiming", - "ReadWriteRace", - "WriteWriteRace", - "Deadlock", - "Starvation", - "AuthorizationError", - "AuthenticationError" - ] - }, - "severity": { - "type": "integer", - "description": "Mandatory. How critical the alarm is" - }, - "persist": { - "type": "boolean", - "description": "Mandatory. If this is an ongoing alarm" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. When the alarm initially started" - } - } - } - } - } - } - }, - "name": "Array" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/monitoring/registration/request": { - "subscribe": { - "summary": "Request monitoring registrations", - "description": "Request all monitoring services to register themselves using the topics below.\n", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/monitoring/add": { - "publish": { - "summary": "Add monitoring service", - "description": "Add monitoring service with their default values and extra settings.\nSettings can be retrieved using the settings API, see <>\n", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "service": { - "type": "object", - "properties": { - "source": { - "type": "string", - "description": "Mandatory. The source of this monitoring service" - }, - "type": { - "type": "string", - "description": "Mandatory. The type of this monitoring service" - }, - "default_settings": { - "type": "object", - "description": "Optional. Any default settings to be overridden", - "properties": { - "enabled": { - "type": "boolean" - }, - "storage_type": { - "type": "object", - "properties": { - "labelKey": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "disk", - "memory" - ] - }, - "persistence_type": { - "type": "object", - "properties": { - "labelKey": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "hours", - "days", - "weeks", - "months", - "items" - ] - }, - "persistence_value": { - "type": "integer" - }, - "cloud_sync": { - "type": "boolean" - }, - "push_notifications": { - "type": "boolean" - }, - "email_notifications": { - "type": "boolean" - } - } - }, - "extraSettings": { - "type": "object", - "description": "Optional. Any extra settings to be registered" - } - } - } - } - }, - "name": "AddMonitoringServiceRequest", - "examples": [ - { - "payload": { - "key": "some_key", - "service": { - "source": "camera", - "type": "mask", - "extraSettings": { - "some_setting": { - "type": "boolean", - "default_value": "true", - "label_key": "some_setting" - } - }, - "default_settings": { - "enabled": true, - "storage_type": "disk", - "persistence_type": "days", - "persistence_value": 7 - } - } - } - } - ] - } - } - }, - "zbos/monitoring/add/response/{key}": { - "subscribe": { - "summary": "Response: Add monitoring service", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/monitoring/event/add": { - "publish": { - "summary": "Add a new event", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "event": { - "type": "object", - "properties": { - "timestamp": { - "type": "number", - "description": "Mandatory. The time at which the event occurred" - }, - "type": { - "type": "string", - "description": "Mandatory. The type of event this is, no dots allowed" - }, - "source": { - "type": "string", - "description": "Mandatory. What device produced this event, no dots allowed" - }, - "value": { - "type": "string", - "description": "Optional. A value relating to the event such as a temperature" - }, - "data": { - "type": "object", - "description": "Optional. Extra data related to the event" - }, - "unit": { - "type": "string", - "description": "Optional. The type of unit the value is expressed in such as °C" - }, - "alarms": { - "type": "array", - "description": "Optional. Alarms attached to this event", - "items": { - "type": "object", - "properties": { - "type": { - "type": "object", - "description": "Mandatory. The type of alarm", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "ItemOmission", - "ItemCommission", - "ServiceOmission", - "ServiceCommission", - "TransientServiceOmission", - "TransientServiceCommission", - "EarlyServiceOmission", - "LateServiceCommission", - "EarlyServiceStart", - "LateServiceStart", - "BoundedOmissionInterval", - "UndetectableValueError", - "BelowRange", - "AboveRange", - "BoundedValueChange", - "StuckValue", - "OutOfBounds", - "OutOfOrder", - "OutOfCalibration", - "EarlyDelivery", - "LateDelivery", - "HighRate", - "LowRate", - "RateJitter", - "EarlyService", - "DelayedService", - "SymmetricReplicationError", - "AsymmetricApproximateValue", - "AsymmetricExactValue", - "AsymmetricItemOmission", - "AsymmetricServiceOmission", - "AsymmetricTiming", - "ReadWriteRace", - "WriteWriteRace", - "Deadlock", - "Starvation", - "AuthorizationError", - "AuthenticationError" - ] - }, - "severity": { - "type": "integer", - "description": "Mandatory. How critical the alarm is" - }, - "persist": { - "type": "boolean", - "description": "Mandatory. If this is an ongoing alarm" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. When the alarm initially started" - } - } - } - } - } - } - } - }, - "name": "AddMonitoringEventRequest", - "examples": [ - { - "payload": { - "key": "some_key", - "event": { - "timestamp": 1.349333576093E12, - "type": "SomeType", - "source": "SomeSource", - "valid": true - } - } - } - ] - } - } - }, - "zbos/monitoring/event/add/response/{key}": { - "subscribe": { - "summary": "response: Add a new event", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/monitoring/event/delete": { - "publish": { - "summary": "Delete an event", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Mandatory. A unique ID for the event" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. The time at which the event occurred" - }, - "type": { - "type": "string", - "description": "Mandatory. The type of event this is, no dots allowed" - }, - "source": { - "type": "string", - "description": "Mandatory. What device produced this event, no dots allowed" - }, - "value": { - "type": "string", - "description": "Optional. A value relating to the event such as a temperature" - }, - "data": { - "type": "object", - "description": "Optional. Extra data related to the event" - }, - "unit": { - "type": "string", - "description": "Optional. The type of unit the value is expressed in such as °C" - }, - "alarms": { - "type": "array", - "description": "Optional. Alarms attached to this event", - "items": { - "type": "object", - "properties": { - "type": { - "type": "object", - "description": "Mandatory. The type of alarm", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "ItemOmission", - "ItemCommission", - "ServiceOmission", - "ServiceCommission", - "TransientServiceOmission", - "TransientServiceCommission", - "EarlyServiceOmission", - "LateServiceCommission", - "EarlyServiceStart", - "LateServiceStart", - "BoundedOmissionInterval", - "UndetectableValueError", - "BelowRange", - "AboveRange", - "BoundedValueChange", - "StuckValue", - "OutOfBounds", - "OutOfOrder", - "OutOfCalibration", - "EarlyDelivery", - "LateDelivery", - "HighRate", - "LowRate", - "RateJitter", - "EarlyService", - "DelayedService", - "SymmetricReplicationError", - "AsymmetricApproximateValue", - "AsymmetricExactValue", - "AsymmetricItemOmission", - "AsymmetricServiceOmission", - "AsymmetricTiming", - "ReadWriteRace", - "WriteWriteRace", - "Deadlock", - "Starvation", - "AuthorizationError", - "AuthenticationError" - ] - }, - "severity": { - "type": "integer", - "description": "Mandatory. How critical the alarm is" - }, - "persist": { - "type": "boolean", - "description": "Mandatory. If this is an ongoing alarm" - }, - "timestamp": { - "type": "number", - "description": "Mandatory. When the alarm initially started" - } - } - } - } - } - }, - "name": "MonitoringEvent", - "examples": [ - { - "payload": { - "id": "some_id", - "timestamp": 1.349333576093E12, - "type": "SomeType", - "source": "SomeSource", - "valid": true - } - } - ] - } - } - }, - "zbos/monitoring/event/delete/event": { - "subscribe": { - "summary": "event: Delete an event", - "description": "", - "tags": [ - { - "name": "Monitoring", - "description": "All monitoring related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key used by the add request" - }, - "success": { - "type": "boolean", - "description": "Did the operation succeed" - }, - "id": { - "type": "string", - "description": "The ID of the new event" - } - } - }, - "name": "MonitoringResponse" - } - } - }, - "zbos/motion/animation/run": { - "publish": { - "summary": "Fires specific animation ID", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "animationId": { - "type": "string" - } - } - }, - "name": "AnimationOptions", - "examples": [ - { - "payload": { - "requestId": "string", - "type": "string", - "animationId": "string" - } - } - ] - } - } - }, - "zbos/motion/animation/stop": { - "publish": { - "summary": "Stops all animations", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/motion/animation/get": { - "publish": { - "summary": "Get available animations", - "description": "see <> for response\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/motion/animation/response/{key}": { - "subscribe": { - "summary": "response: Get available animations", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "animation": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string", - "animation": "string", - "type": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/motion/animation/event": { - "subscribe": { - "summary": "Event: animation started/stopped", - "description": "A message (Boolean) is publish on this topic when an animation started or stopped running\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "boolean" - }, - "name": "Boolean" - } - } - }, - "zbos/motion/dance/start": { - "publish": { - "summary": "Starts dance", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "danceId": { - "type": "string" - } - } - }, - "name": "DanceOptions", - "examples": [ - { - "payload": { - "requestId": "string", - "danceId": "string" - } - } - ] - } - } - }, - "zbos/motion/dance/start/random": { - "publish": { - "summary": "Start random dance", - "description": "Start a random default dance\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/motion/dance/stop": { - "publish": { - "summary": "Stops dance", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/motion/dance/get": { - "publish": { - "summary": "Get available dances", - "description": "see <> for response\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/motion/dance/response/{key}": { - "subscribe": { - "summary": "response: Get available dances", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "animation": { - "type": "string" - }, - "song": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string", - "animation": "string", - "song": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/motion/control/head": { - "publish": { - "summary": "Move the robot head", - "description": "Publish on this topic to move the head of the robot\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "yaw": { - "type": "number", - "description": "Desired yaw for this part if supported, -100 to 100" - }, - "pitch": { - "type": "number", - "description": "Desired pitch for this part if supported, -100 to 100" - }, - "angle": { - "type": "object", - "description": "The direction the part should move in", - "properties": { - "degree": { - "type": "number", - "maximum": 360, - "minimum": 0, - "description": "Angle between 0 and 360" - } - } - }, - "force": { - "type": "number", - "description": "How strongly to perform the movement, 0 to 100" - }, - "distance": { - "type": "number", - "description": "How far the part should move, in meters" - }, - "relative_rotation": { - "type": "number", - "description": "The direction the part should move in relative to its current rotation where negative values rotate to the left and positive values rotate to the right, -360 to 360" - }, - "partName": { - "type": "string" - } - } - }, - "name": "MobilityRequest", - "examples": [ - { - "payload": { - "yaw": 10.0, - "pitch": 0.0, - "angle": { - "degree": 90.0 - }, - "force": 50.0, - "distance": 2.0, - "relative_rotation": 0.0 - } - } - ] - } - } - }, - "zbos/motion/control/movement": { - "publish": { - "summary": "Drive the robot", - "description": "Publish on this topic to drive the robot\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "yaw": { - "type": "number", - "description": "Desired yaw for this part if supported, -100 to 100" - }, - "pitch": { - "type": "number", - "description": "Desired pitch for this part if supported, -100 to 100" - }, - "angle": { - "type": "object", - "description": "The direction the part should move in", - "properties": { - "degree": { - "type": "number", - "maximum": 360, - "minimum": 0, - "description": "Angle between 0 and 360" - } - } - }, - "force": { - "type": "number", - "description": "How strongly to perform the movement, 0 to 100" - }, - "distance": { - "type": "number", - "description": "How far the part should move, in meters" - }, - "relative_rotation": { - "type": "number", - "description": "The direction the part should move in relative to its current rotation where negative values rotate to the left and positive values rotate to the right, -360 to 360" - }, - "partName": { - "type": "string" - } - } - }, - "name": "MobilityRequest", - "examples": [ - { - "payload": { - "yaw": 10.0, - "pitch": 0.0, - "angle": { - "degree": 90.0 - }, - "force": 50.0, - "distance": 2.0, - "relative_rotation": 0.0 - } - } - ] - } - } - }, - "zbos/motion/control/part/{name}": { - "publish": { - "summary": "Move a specific part of the robot", - "description": "Publish on this topic to move a specific part of the robot, like an arm or a leg\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "yaw": { - "type": "number", - "description": "Desired yaw for this part if supported, -100 to 100" - }, - "pitch": { - "type": "number", - "description": "Desired pitch for this part if supported, -100 to 100" - }, - "angle": { - "type": "object", - "description": "The direction the part should move in", - "properties": { - "degree": { - "type": "number", - "maximum": 360, - "minimum": 0, - "description": "Angle between 0 and 360" - } - } - }, - "force": { - "type": "number", - "description": "How strongly to perform the movement, 0 to 100" - }, - "distance": { - "type": "number", - "description": "How far the part should move, in meters" - }, - "relative_rotation": { - "type": "number", - "description": "The direction the part should move in relative to its current rotation where negative values rotate to the left and positive values rotate to the right, -360 to 360" - }, - "partName": { - "type": "string" - } - } - }, - "name": "MobilityRequest", - "examples": [ - { - "payload": { - "yaw": 10.0, - "pitch": 0.0, - "angle": { - "degree": 90.0 - }, - "force": 50.0, - "distance": 2.0, - "relative_rotation": 0.0 - } - } - ] - } - }, - "parameters": { - "name": { - "description": "Name of the part which you want to control", - "schema": { - "type": "string" - } - } - } - }, - "zbos/motion/event": { - "subscribe": { - "summary": "Event: started/stopped", - "description": "A message (Boolean) is publish on this topic when the robot chassis starts, or stops moving.\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "boolean" - }, - "name": "Boolean" - } - } - }, - "zbos/emotion/eyes/run": { - "publish": { - "summary": "Run animation for the eyes", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "emotionId": { - "type": "string" - } - } - }, - "name": "EmotionOptions", - "examples": [ - { - "payload": { - "emotionId": "2" - } - } - ] - } - } - }, - "zbos/emotion/eyes/get": { - "publish": { - "summary": "Get list of available emotions for the eyes", - "description": "see <> for response\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/emotion/eyes/response/{key}": { - "subscribe": { - "summary": "response: Get list of available emotions for the eyes", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "animation": { - "type": "string" - }, - "translationkey": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "2", - "name": "Eyeroll" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/followme/enable": { - "publish": { - "summary": "Enable follow me", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/followme/disable": { - "publish": { - "summary": "Disable follow me", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/followme/event": { - "subscribe": { - "summary": "response: follow me status", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/gestures/data": { - "publish": { - "summary": "Gestures data", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/gestures/enable": { - "publish": { - "summary": "Enable gestures", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/gestures/disable": { - "publish": { - "summary": "Disable gestures", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/gym/get/all": { - "publish": { - "summary": "Get all the gym movements that can be used in the composer", - "description": "see <> for response\n", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/gym/get/all/response/{key}": { - "subscribe": { - "summary": "response: Get all gym movements", - "description": "", - "tags": [ - { - "name": "Motion", - "description": "All motion related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "translation": { - "type": "string" - }, - "exercises": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "translation": { - "type": "string" - }, - "speedIn_min": { - "type": "number" - }, - "speedIn_max": { - "type": "number" - }, - "speedOut_min": { - "type": "number" - }, - "speedOut_max": { - "type": "number" - }, - "duty_min": { - "type": "number" - }, - "duty_max": { - "type": "number" - }, - "period_min": { - "type": "number" - }, - "period_max": { - "type": "number" - }, - "cycles_min": { - "type": "integer" - }, - "cycles_max": { - "type": "integer" - }, - "profiles": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "code": { - "type": "string" - }, - "translation": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "categories": [ - { - "name": "string", - "translation": "string", - "exercises": [ - { - "name": "string", - "translation": "string", - "profiles": [ - { - "name": "string", - "code": "string", - "translation": "string" - } - ], - "speedIn_min": 15.0, - "speedIn_max": 50.0, - "speedOut_min": 25.0, - "speedOut_max": 60.0, - "duty_min": 5.0, - "duty_max": 10.0, - "period_min": 5.0, - "period_max": 10.0, - "cycles_min": 5, - "cycles_max": 10 - } - ] - } - ] - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/security/motiondetect/start": { - "publish": { - "summary": "Start motion detection", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Required key" - }, - "unit": { - "type": "string", - "description": "Can be \"s\", \"h\" or \"m\" (seconds, hours, minutes), used for duration. Defaults to seconds" - }, - "initialDelay": { - "type": "number", - "minimum": 0, - "description": "How long to wait until starting motion detection, in milliseconds. Defaults to 2000, lower values may cause false positives" - }, - "interval": { - "type": "number", - "minimum": 0, - "description": "How often the camera should check for motion, in milliseconds. Defaults to 200" - }, - "duration": { - "type": "number", - "minimum": 0, - "description": "The maximum time the motion detection will be active, after the time is elapsed, the motion detection will stop. Defaults to 10" - }, - "stopOnDetection": { - "type": "boolean", - "description": "If true the motion detection will stop after the first detection. Defaults to true" - }, - "upload": { - "type": "boolean", - "description": "If true, the picture with motion detected will be uploaded to the cloud. A notification is sent to zbos-control (if enabled). Defaults to false" - }, - "stopAfterDuration": { - "type": "boolean", - "description": "If true the motion detection will stop at the end of the duration. Defaults to true" - } - } - }, - "name": "MotionDetectionOptions", - "examples": [ - { - "payload": { - "key": "test", - "unit": "h", - "initialDelay": 2500, - "interval": 250, - "duration": 7, - "stopOnDetection": true, - "upload": true, - "stopAfterDuration": true - } - } - ] - } - } - }, - "zbos/security/motiondetect/stop": { - "publish": { - "summary": "Stop motion detection", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/security/motiondetect/event/{key}": { - "subscribe": { - "summary": "event: Motion detected", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "image": { - "type": "string", - "description": "Image of the detected motion, only given if upload is enabled in motion detection options." - } - } - }, - "name": "MotionDetectionEvent", - "examples": [ - { - "payload": { - "image": "SomeBase64Image" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/security/motiondetect/started/{key}": { - "subscribe": { - "summary": "Motion detection started", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/security/motiondetect/stopped/{key}": { - "subscribe": { - "summary": "Motion detection stopped", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/security/motiondetect/timeout/event/{key}": { - "subscribe": { - "summary": "event: Motion detection timeout", - "description": "", - "tags": [ - { - "name": "Motion detection", - "description": "All motion detection related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/sensors/touch/get": { - "publish": { - "summary": "Get all touch sensors", - "description": "see <> for response\n", - "tags": [ - { - "name": "Sensors", - "description": "All sensors related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/sensors/touch/response/{key}": { - "subscribe": { - "summary": "response: Get all touch sensors", - "description": "", - "tags": [ - { - "name": "Sensors", - "description": "All sensors related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "TOUCHSENSOR", - "TOUCHSENSOR_GROUP" - ] - }, - "translationkey": { - "type": "string" - } - } - }, - "name": "AvailableSensor", - "examples": [ - { - "payload": { - "id": "string", - "type": "TOUCHSENSOR", - "translationkey": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/sensors/event": { - "subscribe": { - "summary": "event: Sensor", - "description": "", - "tags": [ - { - "name": "Sensors", - "description": "All sensors related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "source": { - "type": "string" - }, - "state": { - "type": "string" - } - } - }, - "name": "SensorEvent", - "examples": [ - { - "payload": { - "id": "string", - "type": "string", - "state": "string" - } - } - ] - } - } - }, - "zbos/settings/get": { - "publish": { - "summary": "Get settings", - "description": "Get all settings for the provided category\n", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string" - }, - "setting_keys": { - "type": "array", - "description": "Optional, will return all settings if not set.", - "items": { - "type": "string" - } - }, - "subcategories": { - "type": "object", - "description": "Optional, will return all subcategories if not set." - } - } - }, - "name": "GetSettingsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1" - } - }, - { - "payload": { - "key": "abc", - "category": "category_1", - "setting_keys": [ - "setting_key_1", - "setting_key_2" - ] - } - } - ] - } - } - }, - "zbos/settings/get/response/{key}": { - "publish": { - "summary": "Response: Get settings", - "description": "", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "label_key": { - "type": "string", - "description": "Translation key should use the dot notation: {category}.{key}" - }, - "description_key": { - "type": "string", - "description": "Optional description key\nTranslation key should use the dot notation: {category}.{key}" - }, - "settings": { - "type": "object" - }, - "subcategories": { - "type": "object", - "description": "Optional subcategories" - }, - "orphaned": { - "type": "boolean", - "description": "The orphaned state indicates that this category was not added again since boot." - } - } - }, - "name": "SettingsCategory", - "examples": [ - { - "payload": { - "category": { - "settings": { - "setting_key_1": { - "value": "Value 1", - "type": "string", - "required": true, - "label_key": "translations_category.setting_1_label", - "description_key": "translations_category.setting_1_description" - }, - "setting_key_2": { - "value": "100", - "type": "integer", - "range": { - "min": 0, - "max": 150 - }, - "required": false, - "label_key": "translations_category.setting_2_label", - "description_key": "translations_category.setting_2_description" - }, - "setting_key_3": { - "value": "100.50", - "type": "number", - "range": { - "min": 1, - "max": 150 - }, - "required": true, - "label_key": "translations_category.setting_3_label", - "description_key": "translations_category.setting_3_description" - }, - "setting_key_4": { - "value": "true", - "type": "boolean", - "label_key": "translations_category.setting_4_label", - "description_key": "translations_category.setting_4_description" - }, - "setting_key_5": { - "value": "option_1", - "type": "select_single", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_5_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_5_option_2" - } - ], - "label_key": "translations_category.translations_category.setting_5_label", - "description_key": "translations_category.setting_5_description" - }, - "setting_key_6": { - "values": [ - "option_1", - "option_2" - ], - "type": "select_multi", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_6_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_6_option_2" - }, - { - "key": "option_3", - "value": "Option 3", - "label_key": "translations_category.setting_6_option_3" - } - ], - "label_key": "translations_category.setting_6_label", - "description_key": "translations_category.setting_6_description" - } - }, - "label_key": "translations_category.category_1_label" - } - } - }, - { - "payload": { - "category": { - "settings": { - "setting_key_1": { - "value": "Value 1", - "type": "string", - "required": true, - "label_key": "translations_category.setting_1_label", - "description_key": "translations_category.setting_1_description" - }, - "setting_key_2": { - "value": "100", - "type": "integer", - "range": { - "min": 0, - "max": 150 - }, - "required": false, - "label_key": "translations_category.setting_2_label", - "description_key": "translations_category.setting_2_description" - }, - "setting_key_3": { - "value": "100.50", - "type": "number", - "range": { - "min": 1, - "max": 150 - }, - "required": true, - "label_key": "translations_category.setting_3_label", - "description_key": "translations_category.setting_3_description" - }, - "setting_key_4": { - "value": "true", - "type": "boolean", - "label_key": "translations_category.setting_4_label", - "description_key": "translations_category.setting_4_description" - }, - "setting_key_5": { - "value": "option_1", - "type": "select_single", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_5_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_5_option_2" - } - ], - "label_key": "translations_category.translations_category.setting_5_label", - "description_key": "translations_category.setting_5_description" - }, - "setting_key_6": { - "values": [ - "option_1", - "option_2" - ], - "type": "select_multi", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_6_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_6_option_2" - }, - { - "key": "option_3", - "value": "Option 3", - "label_key": "translations_category.setting_6_option_3" - } - ], - "label_key": "translations_category.setting_6_label", - "description_key": "translations_category.setting_6_description" - } - }, - "subcategories": { - "category_2a": { - "settings": {}, - "label_key": "translations_category.category_2a_label" - } - }, - "label_key": "translations_category.category_2_label" - } - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/settings/request": { - "publish": { - "summary": "Request settings registrations", - "description": "Request all setting providers to register their settings using the topics below.\n", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/settings/add": { - "publish": { - "summary": "Add settings", - "description": "Add settings with their default values.\nThese default values will be used as long as they are not updated via <>\n", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category_name": { - "type": "string" - }, - "file": { - "type": "string", - "description": "Optional. Use either category or file" - }, - "category": { - "type": "object", - "description": "Optional. Use either category or file", - "properties": { - "label_key": { - "type": "string", - "description": "Translation key should use the dot notation: {category}.{key}" - }, - "description_key": { - "type": "string", - "description": "Optional description key\nTranslation key should use the dot notation: {category}.{key}" - }, - "settings": { - "type": "object" - }, - "subcategories": { - "type": "object", - "description": "Optional subcategories" - } - } - } - } - }, - "name": "AddSettingsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": { - "settings": { - "setting_key_1": { - "type": "string", - "required": true, - "default_value": "Value 1", - "label_key": "translations_category.setting_1_label", - "description_key": "translations_category.setting_1_description" - }, - "setting_key_2": { - "type": "integer", - "range": { - "min": 0, - "max": 150 - }, - "required": false, - "default_value": "100", - "label_key": "translations_category.setting_2_label", - "description_key": "translations_category.setting_2_description" - }, - "setting_key_3": { - "type": "number", - "range": { - "min": 1, - "max": 150 - }, - "required": true, - "default_value": "100.50", - "label_key": "translations_category.setting_3_label", - "description_key": "translations_category.setting_3_description" - }, - "setting_key_4": { - "type": "boolean", - "default_value": "true", - "label_key": "translations_category.setting_4_label", - "description_key": "translations_category.setting_4_description" - }, - "setting_key_5": { - "type": "select_single", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_5_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_5_option_2" - } - ], - "default_value": "option_1", - "label_key": "translations_category.translations_category.setting_5_label", - "description_key": "translations_category.setting_5_description" - }, - "setting_key_6": { - "type": "select_multi", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_6_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_6_option_2" - }, - { - "key": "option_3", - "value": "Option 3", - "label_key": "translations_category.setting_6_option_3" - } - ], - "label_key": "translations_category.setting_6_label", - "description_key": "translations_category.setting_6_description" - } - }, - "label_key": "translations_category.category_1_label" - }, - "category_name": "category_1" - } - }, - { - "payload": { - "key": "abc", - "category": { - "settings": { - "setting_key_1": { - "type": "string", - "required": true, - "default_value": "Value 1", - "label_key": "translations_category.setting_1_label", - "description_key": "translations_category.setting_1_description" - }, - "setting_key_2": { - "type": "integer", - "range": { - "min": 0, - "max": 150 - }, - "required": false, - "default_value": "100", - "label_key": "translations_category.setting_2_label", - "description_key": "translations_category.setting_2_description" - }, - "setting_key_3": { - "type": "number", - "range": { - "min": 1, - "max": 150 - }, - "required": true, - "default_value": "100.50", - "label_key": "translations_category.setting_3_label", - "description_key": "translations_category.setting_3_description" - }, - "setting_key_4": { - "type": "boolean", - "default_value": "true", - "label_key": "translations_category.setting_4_label", - "description_key": "translations_category.setting_4_description" - }, - "setting_key_5": { - "type": "select_single", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_5_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_5_option_2" - } - ], - "default_value": "option_1", - "label_key": "translations_category.translations_category.setting_5_label", - "description_key": "translations_category.setting_5_description" - }, - "setting_key_6": { - "type": "select_multi", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_6_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_6_option_2" - }, - { - "key": "option_3", - "value": "Option 3", - "label_key": "translations_category.setting_6_option_3" - } - ], - "label_key": "translations_category.setting_6_label", - "description_key": "translations_category.setting_6_description" - } - }, - "subcategories": { - "category_2a": { - "settings": {}, - "label_key": "translations_category.category_2a_label" - } - }, - "label_key": "translations_category.category_2_label" - }, - "category_name": "category_2" - } - }, - { - "payload": { - "key": "abc", - "file": "path/to/file.json", - "category_name": "category_3" - } - } - ] - } - } - }, - "zbos/settings/add/response/{key}": { - "publish": { - "summary": "Response: Add settings", - "description": "", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/settings/update": { - "publish": { - "summary": "Update settings", - "description": "Update settings overriding the default values.\n", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category_name": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "settings": { - "type": "object" - }, - "subcategories": { - "type": "object", - "description": "Optional subcategories" - } - } - } - } - }, - "name": "UpdateSettingsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": { - "settings": { - "setting_key_1": { - "value": "Value 1B" - }, - "setting_key_2": { - "value": "50" - }, - "setting_key_3": { - "value": "110.20" - }, - "setting_key_4": { - "value": "false" - }, - "setting_key_5": { - "value": "option_2" - }, - "setting_key_6": { - "values": [ - "option_2", - "option_3" - ] - } - }, - "subcategories": { - "category_1a": { - "settings": { - "setting_key_1a": { - "value": "Value 1A" - } - } - } - } - }, - "category_name": "category_1" - } - } - ] - } - } - }, - "zbos/settings/update/response/{key}": { - "publish": { - "summary": "Response: Update settings", - "description": "", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/settings/changed/event/{category}": { - "publish": { - "summary": "Event: Settings changed", - "description": "", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "category_name": { - "type": "string" - }, - "category": { - "type": "object", - "properties": { - "settings": { - "type": "object" - }, - "subcategories": { - "type": "object", - "description": "Optional subcategories" - } - } - } - } - }, - "name": "SettingsChangedEvent", - "examples": [ - { - "payload": { - "category": { - "settings": { - "setting_key_1": { - "type": "string", - "value": "Value 1" - }, - "setting_key_2": { - "type": "integer", - "value": "100" - }, - "setting_key_3": { - "type": "number", - "value": "100.50" - }, - "setting_key_4": { - "type": "boolean", - "value": "true" - }, - "setting_key_5": { - "type": "select_single", - "value": "option_1", - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_5_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_5_option_2" - } - ] - }, - "setting_key_6": { - "type": "select_multi", - "values": [ - "option_1", - "option_2" - ], - "options": [ - { - "key": "option_1", - "value": "Option 1", - "label_key": "translations_category.setting_6_option_1" - }, - { - "key": "option_2", - "value": "Option 2", - "label_key": "translations_category.setting_6_option_2" - }, - { - "key": "option_3", - "value": "Option 3", - "label_key": "translations_category.setting_6_option_3" - } - ] - } - } - }, - "category_name": "category_1" - } - } - ] - } - }, - "parameters": { - "category": { - "description": "ID of the settings category that was changed", - "schema": { - "type": "string" - } - } - } - }, - "zbos/settings/reset": { - "publish": { - "summary": "Reset settings", - "description": "Reset settings to their default values\n", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string" - } - } - }, - "name": "ResetSettingsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1" - } - } - ] - } - } - }, - "zbos/settings/reset/response/{key}": { - "publish": { - "summary": "Response: Reset settings", - "description": "", - "tags": [ - { - "name": "Settings", - "description": "All settings related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/sip/config/event": { - "subscribe": { - "summary": "SIP config changed", - "description": "", - "tags": [ - { - "name": "SIP", - "description": "All sip related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/sip/errors/get": { - "publish": { - "summary": "Get SIP errors", - "description": "see <> for response\n", - "tags": [ - { - "name": "SIP", - "description": "All sip related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/sip/errors/response/{key}": { - "subscribe": { - "summary": "response: SIP errors", - "description": "", - "tags": [ - { - "name": "SIP", - "description": "All sip related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "error": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "error": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/sip/call/end": { - "publish": { - "summary": "End the current SIP call", - "description": "", - "tags": [ - { - "name": "SIP", - "description": "All sip related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/sip/call/end/event": { - "subscribe": { - "summary": "The current SIP call has ended", - "description": "", - "tags": [ - { - "name": "SIP", - "description": "All sip related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - } - } - }, - "name": "CallEndInfo", - "examples": [ - { - "payload": { - "success": true - } - } - ] - } - } - }, - "zbos/slam/start": { - "publish": { - "summary": "Start slam service", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/start/response/{key}": { - "subscribe": { - "summary": "response: Start slam", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/stop": { - "publish": { - "summary": "Stop slam service", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/stop/response/{key}": { - "subscribe": { - "summary": "response: Stop slam", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/error": { - "subscribe": { - "summary": "ERROR in Slam", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "errorCode": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "name": "SlamError", - "examples": [ - { - "payload": { - "errorCode": "String", - "message": "string" - } - } - ] - } - } - }, - "zbos/slam/collision/start/event": { - "subscribe": { - "summary": "One or more collisions have started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "TOUCHSENSOR", - "TOUCHSENSOR_GROUP" - ] - }, - "translationkey": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "type": "TOUCHSENSOR", - "translationkey": "string" - } - } - ] - } - } - }, - "zbos/slam/collision/end/event": { - "subscribe": { - "summary": "One or more collisions have stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "TOUCHSENSOR", - "TOUCHSENSOR_GROUP" - ] - }, - "translationkey": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "type": "TOUCHSENSOR", - "translationkey": "string" - } - } - ] - } - } - }, - "zbos/slam/status/get": { - "publish": { - "summary": "Get SLAM status", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/status/response/{key}": { - "subscribe": { - "summary": "response: Get SLAM status", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mappingConfigurable": { - "type": "boolean" - }, - "mappingEnabled": { - "type": "boolean" - } - } - }, - "name": "SlamStatus", - "examples": [ - { - "payload": { - "mappingConfigurable": true, - "mappingEnabled": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/status/event": { - "subscribe": { - "summary": "event: Status SLAM", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mappingConfigurable": { - "type": "boolean" - }, - "mappingEnabled": { - "type": "boolean" - } - } - }, - "name": "SlamStatus", - "examples": [ - { - "payload": { - "mappingConfigurable": true, - "mappingEnabled": true - } - } - ] - } - } - }, - "zbos/slam/mapview/clear": { - "publish": { - "summary": "Clear current map view", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapview/clear/event": { - "subscribe": { - "summary": "event: Map view cleared", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapview/current": { - "subscribe": { - "summary": "event: Map view changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/mapview/current/get": { - "publish": { - "summary": "Get current map view", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/mapview/current/response/{key}": { - "subscribe": { - "summary": "response: Get current map view", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "data": { - "type": "string" - } - } - }, - "name": "RemoteMapResponseObject", - "examples": [ - { - "payload": { - "mapName": "string", - "data": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/mapping/enable": { - "publish": { - "summary": "Enable SLAM mapping", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/disable": { - "publish": { - "summary": "Disable SLAM mapping", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/start": { - "publish": { - "summary": "Start extending SLAM mapping", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/cancel": { - "publish": { - "summary": "Stop extending SLAM mapping", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/get": { - "publish": { - "summary": "Get extending SLAM mapping", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/mapping/extend/response/{key}": { - "subscribe": { - "summary": "response: Get extending SLAM mapping", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/mapping/extend/started": { - "subscribe": { - "summary": "event: SLAM mapping extending started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/stopped": { - "subscribe": { - "summary": "event: SLAM mapping extending stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/failed": { - "subscribe": { - "summary": "event: SLAM mapping extending failed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/mapping/extend/canceled": { - "subscribe": { - "summary": "event: SLAM mapping extending canceled", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/maps/list/get": { - "publish": { - "summary": "Get maps", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/maps/list/response/{key}": { - "subscribe": { - "summary": "event: Get all maps", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": "Array" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/maps/get/current": { - "publish": { - "summary": "Get current maps", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/maps/get/current/response/{key}": { - "subscribe": { - "summary": "event: Get current maps", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poiList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - } - } - } - }, - "name": "SlamMap", - "examples": [ - { - "payload": { - "mapName": "string", - "poiList": [ - { - "name": "string", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - }, - "inAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - }, - "outAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - } - } - ] - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/maps/load": { - "publish": { - "summary": "Load map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "string" - } - ] - } - } - }, - "zbos/slam/maps/load/event": { - "subscribe": { - "summary": "event: Load map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/maps/save": { - "publish": { - "summary": "Save map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "string" - } - ] - } - } - }, - "zbos/slam/maps/save/event": { - "subscribe": { - "summary": "event: Save map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/maps/delete": { - "publish": { - "summary": "Delete map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "string" - } - ] - } - } - }, - "zbos/slam/maps/delete/all": { - "publish": { - "summary": "Deletes all maps", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/maps/delete/event": { - "subscribe": { - "summary": "event: Delete map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/current": { - "subscribe": { - "summary": "event: Location changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "name": "ZbosLocation", - "examples": [ - { - "payload": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - } - }, - { - "payload": { - "rawX": 0.5, - "rawY": -0.4, - "rawZ": 0.8, - "orientation": { - "yaw": 0.0, - "pitch": 0.0, - "roll": 3.14 - } - } - } - ] - } - } - }, - "zbos/slam/location/current/get": { - "publish": { - "summary": "Get robot location", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/location/current/response/{key}": { - "subscribe": { - "summary": "response: Get robot location", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "name": "ZbosLocation", - "examples": [ - { - "payload": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - } - }, - { - "payload": { - "rawX": 0.5, - "rawY": -0.4, - "rawZ": 0.8, - "orientation": { - "yaw": 0.0, - "pitch": 0.0, - "roll": 3.14 - } - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/location/current/set": { - "publish": { - "summary": "Set robot location", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Required random key" - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - } - } - }, - "name": "ZbosSetLocationRequest", - "examples": [ - { - "payload": { - "key": "string", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - } - } - } - ] - } - } - }, - "zbos/slam/location/current/set/response/{key}": { - "subscribe": { - "summary": "response: Set robot location", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/location/recover": { - "publish": { - "summary": "Recover robot location", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/recover/started": { - "subscribe": { - "summary": "Location revocery started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/recover/stopped": { - "subscribe": { - "summary": "Location revocery stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/recover/failed": { - "subscribe": { - "summary": "Location revocery failed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/reset/chargingstation": { - "publish": { - "summary": "Reset robot to charging station", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/reset/chargingstation/started": { - "subscribe": { - "summary": "Reset robot to charging station started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/reset/chargingstation/stopped": { - "subscribe": { - "summary": "Reset robot to charging station stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/location/home": { - "subscribe": { - "summary": "Home location changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "name": "ZbosLocation", - "examples": [ - { - "payload": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - } - } - ] - } - } - }, - "zbos/slam/location/home/get": { - "publish": { - "summary": "Get home location", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/location/home/response/{key}": { - "subscribe": { - "summary": "response: Get home location", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "name": "ZbosLocation", - "examples": [ - { - "payload": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/walls/clear": { - "publish": { - "summary": "clear all walls", - "description": "Save is optional, if false, then the map will not be saved. By default the map will be saved.\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "save": { - "type": "boolean" - } - } - }, - "name": "WallClearRequest", - "examples": [ - { - "payload": { - "save": true - } - } - ] - } - } - }, - "zbos/slam/walls/clear/event": { - "subscribe": { - "summary": "response: Clear all walls", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/walls/current": { - "subscribe": { - "summary": "Walls changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/walls/current/get": { - "publish": { - "summary": "Get current walls", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/walls/current/response/{key}": { - "subscribe": { - "summary": "response: Get current walls", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/walls/add": { - "publish": { - "summary": "Add wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "Wall", - "examples": [ - { - "payload": { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - } - } - ] - } - } - }, - "zbos/slam/walls/add/event": { - "subscribe": { - "summary": "event: Add wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "Wall", - "examples": [ - { - "payload": { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - } - } - ] - } - } - }, - "zbos/slam/walls/remove": { - "publish": { - "summary": "Remove wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "WallRemoveRequest", - "examples": [ - { - "payload": { - "segmentId": "id5", - "save": true - } - } - ] - } - } - }, - "zbos/slam/walls/remove/multiple": { - "publish": { - "summary": "Remove walls", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": [ - { - "segmentId": "id5", - "save": true - }, - { - "segmentId": "id7", - "save": true - } - ] - } - ] - } - } - }, - "zbos/slam/walls/remove/event": { - "subscribe": { - "summary": "event: Remove wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/walls/update": { - "publish": { - "summary": "Update wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "Wall", - "examples": [ - { - "payload": { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - } - } - ] - } - } - }, - "zbos/slam/walls/update/multiple": { - "publish": { - "summary": "Update walls", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": [ - { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - }, - { - "startPoint": { - "x": 10.0, - "y": 5.0 - }, - "endPoint": { - "x": 20.0, - "y": 10.0 - }, - "segmentId": "another_id", - "save": true - } - ] - } - ] - } - } - }, - "zbos/slam/walls/update/event": { - "subscribe": { - "summary": "event: Update wall", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "startPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "endPoint": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - } - }, - "segmentId": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "Wall", - "examples": [ - { - "payload": { - "startPoint": { - "x": 1.0, - "y": 1.0 - }, - "endPoint": { - "x": 5.0, - "y": 5.0 - }, - "segmentId": "string", - "save": true - } - } - ] - } - } - }, - "zbos/slam/interaction/moveto": { - "publish": { - "summary": "Move robot to coordinates", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - } - } - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - }, - "speed": { - "type": "integer" - } - } - }, - "name": "ZbosMoveToPointRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "coordinate": { - "x": 39.0, - "y": 40.0, - "z": 0.0 - } - } - } - ] - } - } - }, - "zbos/slam/interaction/moveto/started": { - "subscribe": { - "summary": "MoveTo started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/moveto/stopped": { - "subscribe": { - "summary": "MoveTo stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/moveto/failed": { - "subscribe": { - "summary": "MoveTo failed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/moveto/aborted": { - "subscribe": { - "summary": "MoveTo aborted", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/moveto/blocked": { - "subscribe": { - "summary": "MoveTo Blocked", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/moveto/retrying": { - "subscribe": { - "summary": "MoveTo retrying", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/slam/interaction/stop": { - "publish": { - "summary": "Stop moving", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/interaction/stop/event": { - "subscribe": { - "summary": "event: Movement stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/laserscan/enable": { - "publish": { - "summary": "Enable laserscan", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/laserscan/disable": { - "publish": { - "summary": "disable laserscan", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/laserscan/current": { - "subscribe": { - "summary": "event: Laserscan changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "angle": { - "type": "number" - }, - "distance": { - "type": "number" - } - } - }, - "name": "ZbosLaserScan", - "examples": [ - { - "payload": { - "angle": 0.0, - "distance": 15.0 - } - } - ] - } - } - }, - "zbos/slam/poi/current": { - "subscribe": { - "summary": "event: POI changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poiList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - } - } - } - }, - "name": "SlamMap", - "examples": [ - { - "payload": { - "mapName": "First floor", - "poiList": [ - { - "name": "string", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - }, - "inAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - }, - "outAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - } - } - ] - } - } - ] - } - } - }, - "zbos/slam/poi/clear": { - "publish": { - "summary": "Clear all pois", - "description": "Save is optional, if false, then the map will not be saved. By default the map will be saved.\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "ZbosClearPoiRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "save": true - } - } - ] - } - } - }, - "zbos/slam/poi/clear/event": { - "subscribe": { - "summary": "event: Clear all pois", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/poi/list/all/get": { - "publish": { - "summary": "Get list of pois for all maps", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/slam/poi/list/all/response/{key}": { - "subscribe": { - "summary": "event: Get list of pois for all maps", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poiList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - } - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "mapName": "First floor", - "poiList": [ - { - "name": "string", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - }, - "inAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - }, - "outAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - } - } - ] - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/poi/list/get": { - "publish": { - "summary": "Get list of pois for current map", - "description": "see <> for response\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Required random key" - }, - "mapName": { - "type": "string" - } - } - }, - "name": "ZbosMapDetailRequest", - "examples": [ - { - "payload": { - "key": "_dfse", - "mapName": "First floor" - } - } - ] - } - } - }, - "zbos/slam/poi/list/response/{key}": { - "subscribe": { - "summary": "event: Get list of pois for current map", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poiList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - } - } - } - }, - "name": "SlamMap", - "examples": [ - { - "payload": { - "mapName": "First floor", - "poiList": [ - { - "name": "string", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0, - "rawX": 14.8, - "rawY": 15.4 - }, - "inAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - }, - "outAction": { - "actionType": "MQTT", - "radius": 270.0, - "target": "string", - "data": "string" - } - } - ] - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/slam/poi/add": { - "publish": { - "summary": "Add poi", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poi": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - }, - "save": { - "type": "boolean" - } - } - }, - "name": "ZbosAddPoiRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "poi": { - "name": "Home", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0 - } - }, - "save": false - } - } - ] - } - } - }, - "zbos/slam/poi/add/event": { - "subscribe": { - "summary": "event: Add poi", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - }, - "name": "Poi", - "examples": [ - { - "payload": { - "name": "string", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0 - } - } - } - ] - } - } - }, - "zbos/slam/poi/edit": { - "publish": { - "summary": "Edit poi", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "poi": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "CHARGING_STATION", - "INTERACTIVE" - ] - }, - "coordinate": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - }, - "rotation": { - "type": "number" - }, - "rawX": { - "type": "number" - }, - "rawY": { - "type": "number" - }, - "rawZ": { - "type": "number" - }, - "orientation": { - "type": "object", - "properties": { - "yaw": { - "type": "number" - }, - "pitch": { - "type": "number" - }, - "roll": { - "type": "number" - } - } - } - } - }, - "inAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - }, - "outAction": { - "type": "object", - "properties": { - "actionType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MQTT", - "API" - ] - }, - "radius": { - "type": "number" - }, - "target": { - "type": "string", - "description": "Mqtt topic or API url" - }, - "data": { - "type": "string", - "description": "Mqtt payload or post body" - } - } - } - } - }, - "save": { - "type": "boolean" - } - } - }, - "name": "ZbosEditPoiRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "poi": { - "name": "Home", - "uuid": "string", - "type": "DEFAULT", - "coordinate": { - "x": 15.0, - "y": 15.0, - "rotation": 90.0 - } - }, - "save": false - } - } - ] - } - } - }, - "zbos/slam/poi/edit/event": { - "subscribe": { - "summary": "event: Edit poi", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/poi/remove/name": { - "publish": { - "summary": "Remove poi by name", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "ZbosRemovePoiByNameRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "name": "Home", - "save": false - } - } - ] - } - } - }, - "zbos/slam/poi/remove/name/event": { - "subscribe": { - "summary": "event: Remove poi by name", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/poi/remove/uuid": { - "publish": { - "summary": "Remove poi by uuid", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "save": { - "type": "boolean" - } - } - }, - "name": "ZbosRemovePoiByUUIDRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "uuid": "abcd-qsdf-qsdfd-qsdf", - "save": false - } - } - ] - } - } - }, - "zbos/slam/poi/remove/uuid/event": { - "subscribe": { - "summary": "event: Remove poi by uuid", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/poi/moveto/uuid": { - "publish": { - "summary": "Move robot to poi", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "mapName": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "speed": { - "type": "integer", - "$ref": "#/components/schemas/percentage" - } - } - }, - "name": "ZbosMoveToPoiByUUIDRequest", - "examples": [ - { - "payload": { - "mapName": "First floor", - "uuid": "abcd-qsdf-qsdfd-qsdf", - "speed": 50 - } - } - ] - } - } - }, - "zbos/slam/path/remaining/current": { - "subscribe": { - "summary": "Path remaining changed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "remainingPathPoints": { - "type": "array", - "items": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - } - } - } - }, - "remainingMilestones": { - "type": "array", - "items": { - "type": "object", - "properties": { - "x": { - "type": "number" - }, - "y": { - "type": "number" - }, - "z": { - "type": "number" - } - } - } - } - } - }, - "name": "ZbosRemainingPathObject", - "examples": [ - { - "payload": { - "remainingPathPoints": [ - { - "x": 50.0, - "y": 35.0, - "z": 1.0 - } - ], - "remainingMilestones": [ - { - "x": 50.0, - "y": 35.0, - "z": 1.0 - } - ] - } - } - ] - } - } - }, - "zbos/slam/charging/required/started": { - "subscribe": { - "summary": "Charging required", - "description": "Is published when battery is low/critical to indicate the robot is going to try charge itself.\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/charging/required/stopped": { - "subscribe": { - "summary": "Battery is not critical", - "description": "Is published when robot has stopped charging itself\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/charging/goto": { - "publish": { - "summary": "Go to charging station", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/charging/goto/started": { - "subscribe": { - "summary": "Move to charging station started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/charging/goto/stopped": { - "subscribe": { - "summary": "Move to charging station stopped", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/charging/goto/failed": { - "subscribe": { - "summary": "Move to charging station failed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/docking/undock/start": { - "publish": { - "summary": "Undock", - "description": "Leave charging station\n", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/docking/undock/started": { - "subscribe": { - "summary": "Undocking started", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/docking/undock/finished": { - "subscribe": { - "summary": "Undocking finished", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/slam/docking/undock/failed": { - "subscribe": { - "summary": "Undocking failed", - "description": "", - "tags": [ - { - "name": "SLAM", - "description": "All slam related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/languages/available/get": { - "publish": { - "summary": "Get available languages", - "description": "Legacy topic for getting all installed languages (both tts and asr combined). Better not to use this.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/languages/available/response/{key}": { - "subscribe": { - "summary": "response: Get available languages", - "description": "response: Legacy topic for getting all installed languages (both tts and asr combined)\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": "Array", - "examples": [ - { - "payload": "en-US" - }, - { - "payload": "nl-BE" - }, - { - "payload": "fr-FR" - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/languages/current/get": { - "publish": { - "summary": "Get current language", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/languages/current/response/{key}": { - "subscribe": { - "summary": "response: Get current language", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "en-US" - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/languages/current/set": { - "publish": { - "summary": "Set current language", - "description": "Set the active language, example: 'en-US'. Note: this will be probably be changed to <> in a future release.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "en-US" - } - ] - } - } - }, - "zbos/dialog/set/message": { - "publish": { - "summary": "Speak a message", - "description": "Use this to make the robot say something.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "Hello world" - } - ] - } - } - }, - "zbos/dialog/set": { - "publish": { - "summary": "Speak a message with parameters", - "description": "Use this to make the robot say something with parameters. Only message is required, other params are optional.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "requestId": { - "type": "string" - }, - "message": { - "type": "string" - }, - "speed": { - "type": "integer" - }, - "language": { - "type": "string", - "description": "Language string like \"en-US\"" - }, - "volume": { - "type": "integer" - }, - "gesticulation": { - "type": "boolean" - }, - "voice": { - "type": "string" - }, - "pitch": { - "type": "integer" - }, - "blocking": { - "type": "boolean" - } - } - }, - "name": "DialogOptions", - "examples": [ - { - "payload": { - "requestId": "1", - "message": "Hello world", - "speed": 50, - "language": "en-US", - "volume": 50, - "gesticulation": true, - "voice": "Ava", - "pitch": 120 - } - } - ] - } - } - }, - "zbos/dialog/languages/current/event": { - "subscribe": { - "summary": "event: Current language", - "description": "Event when the system is done with changing language to a new language.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "en-US" - } - ] - } - } - }, - "zbos/dialog/animatedspeech/enable": { - "publish": { - "summary": "Enable animated speech", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/animatedspeech/disable": { - "publish": { - "summary": "Disable animated speech", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/animatedspeech/get": { - "publish": { - "summary": "Get status of animated speech", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/animatedspeech/response/{key}": { - "subscribe": { - "summary": "response: Get status of animated speech", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "boolean" - }, - "name": "Boolean" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/tts/start": { - "publish": { - "summary": "event: TTS started", - "description": "Event when the robot starts speaking and what it is saying\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "Hi, my name is James" - } - ] - } - } - }, - "zbos/dialog/tts/stop": { - "publish": { - "summary": "Stop robot speech", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/pause/hotword": { - "publish": { - "summary": "pause hotword recognition", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/resume/hotword": { - "publish": { - "summary": "resume hotword recognition", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/tts/end": { - "subscribe": { - "summary": "event: TTS ended", - "description": "Event when the robot has finished speaking\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/dialog/hotword/recognised": { - "subscribe": { - "summary": "event: robot has recognised a hotword", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/event/dialog/listen/started": { - "subscribe": { - "summary": "event: robot starts listening", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/event/dialog/listen/stopped": { - "subscribe": { - "summary": "event: robot stops listening", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/listen/start": { - "publish": { - "summary": "Start listening", - "description": "Start listening for hotword and commands\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/listen/stop": { - "publish": { - "summary": "Stop listening", - "description": "Cancel hotword recognition\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/service/start": { - "publish": { - "summary": "Start dialog service", - "description": "Start the dialog service so the robot can listen to the mic.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/service/stop": { - "publish": { - "summary": "Stop dialog service", - "description": "Stop the dialog service so the mic is free to use by other applications.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/service/stopped": { - "subscribe": { - "summary": "Event: dialog service stopped", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/service/started": { - "subscribe": { - "summary": "Event: dialog service started", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/iflytek/rotation/started": { - "subscribe": { - "summary": "Iflytek rotation started", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/iflytek/rotation/stopped": { - "subscribe": { - "summary": "Iflytek rotation stopped", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/tts/phonemereached": { - "subscribe": { - "summary": "event. Phoneme reached", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "jawOpen": { - "type": "boolean" - }, - "lipTension": { - "type": "integer" - }, - "mouthHeight": { - "type": "integer" - }, - "mouthUpturn": { - "type": "integer" - }, - "mouthWidth": { - "type": "integer" - }, - "teethLowerVisible": { - "type": "integer" - }, - "teethUpperVisible": { - "type": "integer" - }, - "tonguePosition": { - "type": "integer" - } - } - }, - "name": "PhonemeInfo", - "examples": [ - { - "payload": { - "jawOpen": false, - "lipTension": 0, - "mouthHeight": 10, - "mouthUpturn": 0, - "mouthWidth": 5, - "teethLowerVisible": 1, - "teethUpperVisible": 1, - "tonguePosition": 1 - } - } - ] - } - } - }, - "zbos/dialog/grammars/add/multiple": { - "publish": { - "summary": "Grammars: add multiple", - "description": "This is an extension for the grammar add topic. It removes all grammars first and then triggers a single platform reload. Hence grammars are added a lot faster.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "a unique id of the grammar. This must be unique among the application (next field)." - }, - "app": { - "type": "string", - "description": "The application name. This will be used to determined which MQTT topic will be used to post the json output to." - }, - "continuous": { - "type": "boolean" - }, - "input": { - "type": "object", - "description": "Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands." - }, - "variables": { - "type": "object" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "question_1_variable", - "app": "App", - "continuous": true, - "input": { - "nl-BE": [ - "Ken jij $name" - ], - "en-US": [ - "Do you know $name" - ] - }, - "variables": { - "name": { - "nl-BE": [ - { - "input": "Arno", - "data": "name_in_dutch" - }, - { - "input": "Gilles", - "data": "name_in_dutch" - } - ], - "en-US": [ - { - "input": "Arno", - "data": "name_in_english" - }, - { - "input": "Gilles", - "data": "name_in_english" - } - ] - } - } - } - } - ] - } - } - }, - "zbos/dialog/grammars/add/response": { - "subscribe": { - "summary": "response: grammar add", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/dialog/grammars/remove/multiple": { - "publish": { - "summary": "Grammars: remove multiple", - "description": "This is an extension for the grammar remove topic. It removes all grammars first and then triggers a single platform reload. Hence grammars are removed a lot faster.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "a unique id of the grammar. This must be unique among the application (next field)." - }, - "app": { - "type": "string", - "description": "The application name. This will be used to determined which MQTT topic will be used to post the json output to." - }, - "continuous": { - "type": "boolean" - }, - "input": { - "type": "object", - "description": "Contains an array for each language with all the possible sentences. The sentences need to be in a format that the speech software understands." - }, - "variables": { - "type": "object" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "id send in add", - "app": "app from add" - } - } - ] - } - } - }, - "zbos/dialog/grammars/remove/response": { - "subscribe": { - "summary": "response: grammar add", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/dialog/grammars/match/{appId}": { - "publish": { - "summary": "Event: grammar match", - "description": "Event when a custom grammar match is found, the output data is posted here. \n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "app": { - "type": "string" - }, - "triggered-by": { - "type": "string", - "description": "The id of the grammer that has matched with the user input. This is the id from the input json." - }, - "language": { - "type": "string", - "description": "Language that speech software was configured in when the sentence is recognised." - }, - "variables": { - "type": "object" - } - } - }, - "name": "GrammarMatch", - "examples": [ - { - "payload": { - "language": "en-US", - "variables": { - "beverage": { - "input": "Wine", - "data": "this is wine" - }, - "dish": { - "input": "hamburger", - "data": "this is a hamburger" - } - }, - "triggered-by": "input ID" - } - } - ] - } - }, - "parameters": { - "appId": { - "description": "Should be replaced by the app id used in the 'zbos/dialog/grammars/add/multiple' topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/custom/grammar/rules/get": { - "publish": { - "summary": "Gets all custom grammar rules", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/custom/grammar/rules/get/response": { - "subscribe": { - "summary": "response: Get all custom grammar rules", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "string" - } - }, - "name": "Array" - } - } - }, - "zbos/dialog/tts/languages/get": { - "publish": { - "summary": "Get TTS languages", - "description": "Get a list of languages that the TTS engine can use to talk.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/tts/languages/response/{key}": { - "subscribe": { - "summary": "response: TTS languages list", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "BE" - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/tts/languages/current/get": { - "publish": { - "summary": "Get current TTS language", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/tts/languages/current/set": { - "publish": { - "summary": "Set TTS language", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "nl-BE" - } - ] - } - } - }, - "zbos/dialog/asr/languages/get": { - "publish": { - "summary": "Get ASR languages", - "description": "Get a list of languages recognized by the ASR engine. note: For now this is limited to the language code defined in the config. No Vocon load check is done yet.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/asr/languages/response/{key}": { - "subscribe": { - "summary": "response: ASR languages list", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "nl-BE" - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/asr/languages/current/get": { - "publish": { - "summary": "Get current ASR language", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/asr/languages/current/set": { - "publish": { - "summary": "Set ASR language", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "nl-BE" - } - ] - } - } - }, - "zbos/asr/recognition/result": { - "subscribe": { - "summary": "Speech recognised event", - "description": "Event send by the dialog service when user said something. Mainly for subtitles.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "Okay James" - } - ] - } - } - }, - "zbos/dialog/grammars/load": { - "publish": { - "summary": "Grammars: load", - "description": "Request from speech software to load custom grammars from the storage on the robot.see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/grammars/load/response": { - "subscribe": { - "summary": "response: loaded grammars", - "description": "Response from the RIL with all the rules stored in a file on the robot.\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/speech/provider/start": { - "publish": { - "summary": "Start speech provider", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/speech/provider/stop": { - "publish": { - "summary": "Stop speech provider", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/text/command": { - "publish": { - "summary": "Send a text message to dialog system", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/dialog/language/setup/start": { - "publish": { - "summary": "Start language setup", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/language/setup/stop": { - "publish": { - "summary": "Stop language setup", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/dialog/set/config": { - "publish": { - "summary": "Set the current speech config", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "config_items": { - "type": "object", - "description": "One or more config items." - }, - "key": { - "type": "string", - "description": "Required random key" - } - } - }, - "name": "SetDialogConfigRequest", - "examples": [ - { - "payload": { - "key": "ABCxyz", - "config_items": {} - } - } - ] - } - } - }, - "zbos/dialog/set/config/response/{key}": { - "subscribe": { - "summary": "response: Speech config was set", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "config_items": { - "type": "object", - "description": "One or more config items." - }, - "key": { - "type": "string", - "description": "Required random key" - } - } - }, - "name": "SetDialogConfigRequest", - "examples": [ - { - "payload": { - "key": "ABCxyz", - "config_items": {} - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/dialog/get/config": { - "publish": { - "summary": "Get the current speech config", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "config_items": { - "type": "array", - "description": "One or more config keys.", - "items": { - "type": "string" - } - }, - "key": { - "type": "string", - "description": "Required random key" - } - } - }, - "name": "GetDialogConfigRequest", - "examples": [ - { - "payload": { - "key": "ABCxyz", - "config_items": [] - } - } - ] - } - } - }, - "zbos/dialog/get/config/response": { - "subscribe": { - "summary": "response: Current dialog config", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "config_items": { - "type": "array", - "description": "One or more config keys.", - "items": { - "type": "string" - } - }, - "key": { - "type": "string", - "description": "Required random key" - } - } - }, - "name": "GetDialogConfigRequest", - "examples": [ - { - "payload": { - "key": "ABCxyz", - "config_items": [] - } - } - ] - } - } - }, - "zbos/dialog/reset/config": { - "publish": { - "summary": "Reset the current speech config", - "description": "see <> for response\n", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/dialog/reset/config/response": { - "subscribe": { - "summary": "response: Config has been reset", - "description": "", - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/notification/all/event": { - "subscribe": { - "summary": "Notify everything", - "description": "", - "tags": [ - { - "name": "Status", - "description": "All status related topics." - } - ], - "message": { - "$ref": "#/components/messages/notificationMessage" - } - } - }, - "zbos/notification/info/event": { - "subscribe": { - "summary": "Notify information", - "description": "", - "tags": [ - { - "name": "Status", - "description": "All status related topics." - } - ], - "message": { - "$ref": "#/components/messages/notificationMessage" - } - } - }, - "zbos/notification/warning/event": { - "subscribe": { - "summary": "Notify warnings", - "description": "", - "tags": [ - { - "name": "Status", - "description": "All status related topics." - } - ], - "message": { - "$ref": "#/components/messages/notificationMessage" - } - } - }, - "zbos/notification/error/event": { - "subscribe": { - "summary": "Notify errors", - "description": "", - "tags": [ - { - "name": "Status", - "description": "All status related topics." - } - ], - "message": { - "$ref": "#/components/messages/notificationMessage" - } - } - }, - "zbos/survey/get": { - "publish": { - "summary": "Get survey", - "description": "see <> for response\n", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/survey/get/response/{key}": { - "subscribe": { - "summary": "response: Get survey", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/survey/all/get": { - "publish": { - "summary": "Get all surveys", - "description": "see <> for response\n", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/survey/all/get/response/{key}": { - "subscribe": { - "summary": "response: Get all surveys", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "meta": { - "type": "object", - "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } - }, - "default_language": { - "type": "string" - }, - "version": { - "type": "string" - }, - "created_on": { - "type": "string" - }, - "last_updated_on": { - "type": "string" - } - } - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/survey/save": { - "publish": { - "summary": "Add/save survey", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "meta": { - "type": "object", - "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } - }, - "default_language": { - "type": "string" - }, - "version": { - "type": "string" - }, - "created_on": { - "type": "string" - }, - "last_updated_on": { - "type": "string" - } - } - } - } - }, - "name": "SimpleSurvey", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/survey/save/event": { - "subscribe": { - "summary": "event: Survey added/saved", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/survey/delete": { - "publish": { - "summary": "Delete survey", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "meta": { - "type": "object", - "properties": { - "languages": { - "type": "array", - "items": { - "type": "string" - } - }, - "default_language": { - "type": "string" - }, - "version": { - "type": "string" - }, - "created_on": { - "type": "string" - }, - "last_updated_on": { - "type": "string" - } - } - } - } - }, - "name": "SimpleSurvey", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/survey/delete/event": { - "subscribe": { - "summary": "event: Survey deleted", - "description": "", - "tags": [ - { - "name": "Survey", - "description": "All survey related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/alarm/trigger": { - "publish": { - "summary": "Call for help", - "description": "Send an Alarm message, trigger alarm, call for help.\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "serverDomain": { - "type": "string" - }, - "localUsername": { - "type": "string" - }, - "localPassword": { - "type": "string" - }, - "localPort": { - "type": "integer" - }, - "peerUsername": { - "type": "string" - }, - "peerPassword": { - "type": "string" - }, - "peerPort": { - "type": "integer" - }, - "metaData": { - "type": "object" - }, - "alarmType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "DEFAULT", - "VERKLIZAN", - "SENSOR" - ] - }, - "callTimeout": { - "type": "integer" - }, - "hangupAllowed": { - "type": "boolean" - }, - "enabled": { - "type": "boolean" - } - } - }, - "name": "SipConfig", - "examples": [ - { - "payload": { - "serverDomain": "string", - "localUsername": "string", - "localPassword": "string", - "localPort": 5060, - "peerUsername": "string", - "peerPassword": "string", - "peerPort": 5060, - "metaData": {}, - "alarmType": "DEFAULT", - "callTimeout": 120000, - "hangupAllowed": false, - "enabled": false - } - } - ] - } - } - }, - "zbos/alarm/trigger/event": { - "subscribe": { - "summary": "event: Trigger alarm and call for help", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/alarm/call/started": { - "subscribe": { - "summary": "Alarm call started", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/alarm/call/established": { - "subscribe": { - "summary": "Alarm call established", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/alarm/call/ended": { - "subscribe": { - "summary": "Alarm call ended", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/alarm/set": { - "publish": { - "summary": "Set alarm call", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "alarmServiceProvider": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "verklizan", - "sensor" - ] - }, - "metadata": { - "type": "object" - } - } - }, - "name": "ZbosAlarm", - "examples": [ - { - "payload": { - "key": "string", - "alarmServiceProvider": "sensor", - "metadata": {} - } - } - ] - } - } - }, - "zbos/alarm/set/response": { - "subscribe": { - "summary": "response: Set alarm call", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/alarm/event": { - "subscribe": { - "summary": "Alarm has been received", - "description": "An event indicating an alarm was triggered\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "Map" - } - } - }, - "zbos/alarm/config/get": { - "publish": { - "summary": "Get alarm configs", - "description": "Get an object containing all alarm configssee <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/alarm/config/get/response/{key}": { - "subscribe": { - "summary": "Get alarm configs response", - "description": "Response of configs by alarm name\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object" - }, - "name": "HashMap" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/alarm/config/set": { - "publish": { - "summary": "Set alarm config ", - "description": "Sets the config for a specific alarm type\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "type": { - "type": "string" - }, - "config": { - "type": "object" - } - } - }, - "name": "AlarmConfigRequest", - "examples": [ - { - "payload": { - "type": "string", - "config": { - "string": "string" - } - } - } - ] - } - } - }, - "zbos/alarm/config/set/event": { - "subscribe": { - "summary": "Set alarm config response", - "description": "An event indicating the alarm config was changed\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "error": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "MALFORMED_REQUEST", - "MISSING_CONFIG_PROPERTY", - "TYPE_NOT_FOUND" - ] - } - } - }, - "name": "AlarmConfigResult", - "examples": [ - { - "payload": { - "type": "string", - "config": { - "string": "string" - } - } - } - ] - } - } - }, - "zbos/alarm/database/get": { - "publish": { - "summary": "Get alarm database", - "description": "Retrieves a list of all the alarms stored in the databasesee <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/alarm/database/get/response/{key}": { - "subscribe": { - "summary": "Get alarm database response", - "description": "The response to a database get request\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string" - }, - "downloadPath": { - "type": "string" - }, - "previewPath": { - "type": "string" - }, - "mediaFile": { - "type": "string" - }, - "timestamp": { - "type": "number" - }, - "metadata": { - "type": "object" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "type": "string", - "downloadPath": "string", - "previewPath": "string", - "mediaFile": "string", - "timestamp": 1012001, - "metadata": {} - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/alarm/database/remove": { - "publish": { - "summary": "Remove alarm database", - "description": "Remove all alarms from the database\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/alarm/database/remove/event": { - "subscribe": { - "summary": "Remove alarm database response", - "description": "An event indicating the alarm database was removed\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/alarm/images/remove": { - "publish": { - "summary": "Remove alarm images", - "description": "Remove all alarm images from the robot\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/alarm/images/remove/event": { - "subscribe": { - "summary": "Remove alarm images response", - "description": "An event indicating images were removed\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/alarm/all/remove": { - "publish": { - "summary": "Remove alarm images and database", - "description": "Remove all alarm images and database entries from the robot\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/alarm/all/remove/event": { - "subscribe": { - "summary": "Remove alarm images and database response", - "description": "An event indicating images and databases were removed\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/status/battery/get": { - "publish": { - "summary": "Get battery status", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/status/battery/response/{key}": { - "subscribe": { - "summary": "response: Get battery status", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "level": { - "type": "integer", - "$ref": "#/components/schemas/percentage" - }, - "charging": { - "type": "boolean" - }, - "docked": { - "type": "boolean" - } - } - }, - "name": "BatteryEvent", - "examples": [ - { - "payload": { - "level": 50, - "charging": true, - "docked": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/status/battery/event": { - "subscribe": { - "summary": "event: Battery change", - "description": "A message (json) is published on this topic when the robot battery status changes. Level is the battery level in percent. If the battery status is not yet available, then the level is -1.\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "level": { - "type": "integer", - "$ref": "#/components/schemas/percentage" - }, - "charging": { - "type": "boolean" - }, - "docked": { - "type": "boolean" - } - } - }, - "name": "BatteryEvent", - "examples": [ - { - "payload": { - "level": 50, - "charging": true, - "docked": true - } - } - ] - } - } - }, - "zbos/status/battery/low/set": { - "publish": { - "summary": "Set the battery low level threshold", - "description": "At what battery percentage the robot will act as if it is at low battery\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "percent": { - "type": "integer", - "$ref": "#/components/schemas/percentage" - } - } - }, - "name": "BatterySetRequest", - "examples": [ - { - "payload": { - "percent": 30 - } - } - ] - } - } - }, - "zbos/status/battery/low/get": { - "publish": { - "summary": "Get the battery low level threshold", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/status/battery/low/response/{key}": { - "subscribe": { - "summary": "Response: battery low level", - "description": "Response which shows the battery low level threshold\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/status/battery/critical/set": { - "publish": { - "summary": "Set the battery critical level threshold", - "description": "At what battery percentage the robot will act as if it is at critical battery\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "percent": { - "type": "integer", - "$ref": "#/components/schemas/percentage" - } - } - }, - "name": "BatterySetRequest", - "examples": [ - { - "payload": { - "percent": 10 - } - } - ] - } - } - }, - "zbos/status/battery/critical/get": { - "publish": { - "summary": "Get the battery critical level threshold", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/status/battery/critical/response/{key}": { - "subscribe": { - "summary": "Response: battery critical level", - "description": "Response which shows the battery critical level threshold\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/robot/identification/get": { - "publish": { - "summary": "Request robot identification", - "description": "Use this to ask a detailed list of robot specifics like serial, features, ...\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/robot/identification/event": { - "subscribe": { - "summary": "response: Robot identification", - "description": "A detailed list of robot specifics\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "robot_type": { - "type": "string" - }, - "body_id": { - "type": "string" - }, - "serial": { - "type": "string" - }, - "name": { - "type": "string" - }, - "versions": { - "type": "object" - }, - "network_info": { - "type": "object", - "properties": { - "ip": { - "type": "string" - }, - "mac_address": { - "type": "string" - }, - "ssid": { - "type": "string" - } - } - }, - "features": { - "type": "object", - "properties": { - "audio": { - "type": "object", - "properties": { - "control_parameters": { - "type": "object", - "properties": { - "pitch": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - }, - "speed": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - }, - "volume": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - } - } - } - } - }, - "external_displays": { - "type": "array", - "items": { - "type": "object", - "properties": { - "video": { - "type": "boolean" - }, - "audio": { - "type": "boolean" - }, - "width": { - "type": "integer" - }, - "height": { - "type": "integer" - } - } - } - }, - "cameras": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "primary": { - "type": "boolean" - }, - "rotation": { - "type": "integer" - }, - "image_rotation": { - "type": "integer" - } - } - } - }, - "can_poi": { - "type": "boolean" - }, - "can_move": { - "type": "boolean" - }, - "can_dance": { - "type": "boolean" - }, - "can_speech": { - "type": "boolean" - }, - "has_storage": { - "type": "boolean" - }, - "can_animate": { - "type": "boolean" - }, - "can_gym": { - "type": "boolean" - }, - "has_sensors": { - "type": "boolean" - }, - "has_emotions": { - "type": "boolean" - }, - "can_video_stream": { - "type": "boolean" - }, - "can_take_picture": { - "type": "boolean" - }, - "has_slam_image_map": { - "type": "boolean" - }, - "has_security_mode": { - "type": "boolean" - }, - "can_detect_motion": { - "type": "boolean" - }, - "can_face_recognize": { - "type": "boolean" - }, - "can_poi_interactive": { - "type": "boolean" - }, - "has_monitoring": { - "type": "boolean" - }, - "has_qr_scanner": { - "type": "boolean" - }, - "can_change_ntp_server": { - "type": "boolean" - }, - "voice_feature": { - "type": "object", - "properties": { - "supports_gesticulate": { - "type": "boolean" - }, - "supports_language": { - "type": "boolean" - }, - "supports_pitch": { - "type": "boolean" - }, - "supports_speed": { - "type": "boolean" - }, - "supports_volume": { - "type": "boolean" - }, - "supports_speech_volume": { - "type": "boolean" - }, - "control_parameters": { - "type": "object", - "properties": { - "pitch": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - }, - "speed": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - }, - "volume": { - "type": "object", - "properties": { - "min": { - "type": "integer" - }, - "step": { - "type": "integer" - }, - "default": { - "type": "integer" - }, - "max": { - "type": "integer" - } - } - } - } - } - } - }, - "listen_feature": { - "type": "object", - "properties": { - "can_trigger_manual": { - "type": "boolean" - }, - "can_trigger_hotword": { - "type": "boolean" - } - } - }, - "slam_feature": { - "type": "object", - "properties": { - "can_navigate": { - "type": "boolean" - }, - "can_extend_map": { - "type": "boolean" - }, - "can_manage_pois": { - "type": "boolean" - }, - "can_manage_walls": { - "type": "boolean" - }, - "has_docking_station": { - "type": "boolean" - } - } - }, - "voip_feature": { - "type": "object", - "properties": { - "supports_voip": { - "type": "boolean" - } - } - }, - "face_recognition_feature": { - "type": "object", - "properties": { - "can_detect_known_faces": { - "type": "boolean" - }, - "can_detect_number_of_faces": { - "type": "boolean" - } - } - }, - "time_feature": { - "type": "object", - "properties": { - "can_change_time_zone": { - "type": "boolean" - } - } - }, - "print_feature": { - "type": "object", - "properties": { - "can_print": { - "type": "boolean" - } - } - }, - "health_certificates_feature": { - "type": "object", - "properties": { - "can_check_certificates": { - "type": "boolean" - } - } - } - } - }, - "hardware": { - "type": "object", - "properties": { - "heads": { - "type": "array", - "items": { - "type": "object", - "properties": { - "moveable": { - "type": "boolean" - }, - "can_reset_to_default_position": { - "type": "boolean" - } - } - } - }, - "parts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "moveable": { - "type": "boolean" - }, - "can_reset_to_default_position": { - "type": "boolean" - } - } - } - }, - "usb": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "USB_1", - "USB_1_1", - "USB_2", - "USB_3", - "USB_3_1", - "USB_3_2", - "USB_4" - ] - } - } - } - } - } - }, - "composer": { - "type": "object", - "properties": { - "simple": { - "type": "object", - "properties": { - "dance": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "speech": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "animation": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "emotion": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_duration": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_sensor": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_face": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_voice": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_qr_code": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "wait_monitoring": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "motion_head": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "motion_detection": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "multimedia": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "poi": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "mqtt": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "app_start": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "change_datasource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "input": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "multimedia_stop": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "browser": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "gym": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "print": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "text_overlay": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - } - } - }, - "advanced": { - "type": "object", - "properties": { - "math_formula": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "math_operations": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "if_else": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "variables": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "api": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "loop": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "start": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "stop": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - }, - "health_certificate": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "enabled_sources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "topicName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "scheduler", - "composer" - ] - } - }, - "can_block": { - "type": "boolean" - } - } - } - } - } - } - }, - "supported_file_types": { - "type": "array", - "items": { - "type": "object", - "properties": { - "mime_type": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - }, - "connection_features": { - "type": "object", - "properties": { - "has_wifi": { - "type": "boolean" - }, - "has_cable": { - "type": "boolean" - }, - "has_hotspot": { - "type": "boolean" - }, - "cable_features": { - "type": "object", - "properties": { - "adapter_names": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "wifi_features": { - "type": "object", - "properties": { - "can_configure": { - "type": "boolean" - }, - "adapter_names": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "hotspot_features": { - "type": "object", - "properties": { - "can_activate": { - "type": "boolean" - }, - "can_change_ssid": { - "type": "boolean" - }, - "can_change_password": { - "type": "boolean" - }, - "adapter_names": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "name": "RobotIdentification", - "examples": [ - { - "payload": { - "serial": "SH-J01-00096", - "name": "Jamesy", - "versions": {}, - "features": { - "audio": { - "control_parameters": { - "pitch": { - "min": 0, - "step": 1, - "default": 50, - "max": 100 - }, - "speed": { - "min": 0, - "step": 1, - "default": 50, - "max": 100 - }, - "volume": { - "min": 0, - "step": 1, - "default": 50, - "max": 100 - } - } - }, - "cameras": [ - { - "key": "kiosk", - "primary": true, - "rotation": 0 - } - ], - "external_displays": [ - { - "video": true, - "audio": true, - "width": 1280, - "height": 800 - } - ], - "can_poi": true, - "can_move": true, - "can_dance": false, - "can_speech": true, - "has_storage": true, - "can_animate": false, - "can_gym": false, - "has_sensors": true, - "has_emotions": false, - "can_video_stream": true, - "can_take_picture": true, - "has_slam_image_map": true, - "has_security_mode": true, - "can_detect_motion": true, - "can_face_recognize": true, - "can_poi_interactive": true, - "has_monitoring": false, - "has_qr_scanner": false, - "can_change_ntp_server": false, - "voice_feature": { - "supports_gesticulate": false, - "supports_language": true, - "supports_pitch": true, - "supports_speed": true, - "supports_volume": true, - "supports_speech_volume": true - }, - "listen_feature": { - "can_trigger_manual": true, - "can_trigger_hotword": true - }, - "slam_feature": { - "can_navigate": true, - "can_extend_map": true, - "can_manage_pois": true, - "can_manage_walls": true, - "has_docking_station": false - }, - "voip_feature": { - "supports_voip": true - }, - "face_recognition_feature": { - "can_detect_known_faces": false, - "can_detect_number_of_faces": true - }, - "time_feature": { - "can_change_time_zone": true - }, - "print_feature": { - "can_print": true - }, - "health_certificates_feature": { - "can_check_certificates": true - } - }, - "hardware": { - "heads": [ - { - "moveable": true, - "can_reset_to_default_position": true - } - ], - "parts": [ - { - "name": "Leg", - "moveable": false, - "can_reset_to_default_position": false - } - ] - }, - "composer": { - "simple": { - "dance": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "speech": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "animation": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "emotion": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "multimedia": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "poi": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "mqtt": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "input": { - "enabled": true, - "enabled_sources": [ - "composer" - ], - "can_block": true - }, - "browser": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "gym": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "wait_duration": { - "enabled": true, - "enabled_sources": [ - "composer" - ], - "can_block": true - }, - "wait_sensor": { - "enabled": true, - "enabled_sources": [ - "composer" - ], - "can_block": true - }, - "wait_face": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "wait_voice": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "wait_qr_code": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "motion_head": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "motion_detection": { - "enabled": true, - "enabled_sources": [ - "composer" - ], - "can_block": true - }, - "app_start": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "change_datasource": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - }, - "multimedia_stop": { - "enabled": true, - "enabled_sources": [ - "scheduler", - "composer" - ], - "can_block": true - } - }, - "advanced": { - "variables": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "api": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "loop": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "start": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "stop": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "math_formula": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "math_operations": { - "enabled": false, - "enabled_sources": [], - "can_block": true - }, - "if_else": { - "enabled": false, - "enabled_sources": [], - "can_block": true - } - } - }, - "robot_type": "James", - "body_id": "D2EE32C8F3EFF59FDFEAF6E21834F71C", - "network_info": { - "ip": "172.16.0.100", - "ssid": "string", - "mac_address": "02:00:00:00:00:00" - }, - "supported_file_types": [ - { - "type": "string", - "mime_type": "string" - } - ], - "connection_features": { - "has_wifi": true, - "has_cable": false, - "has_hotspot": true, - "cable_features": { - "adapter_names": [] - }, - "wifi_features": { - "can_configure": false, - "adapter_names": [ - "wlan0" - ] - }, - "hotspot_features": { - "can_activate": true, - "can_change_ssid": true, - "can_change_password": true, - "adapter_names": [ - "WIFI1", - "WIFI2" - ] - } - } - } - } - ] - } - } - }, - "zbos/system/name/set": { - "publish": { - "summary": "Set robot name", - "description": "Use this to change the robot name. The change will be published through <>\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String", - "examples": [ - { - "payload": "Betsy" - } - ] - } - } - }, - "zbos/system/version/get": { - "publish": { - "summary": "Get system version", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/version/response/{key}": { - "subscribe": { - "summary": "response: Get system version", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "name": "AppVersion", - "examples": [ - { - "payload": { - "name": "CR-16", - "version": "4.2.0" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/serial/get": { - "publish": { - "summary": "Get system serial number", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/serial/response/{key}": { - "subscribe": { - "summary": "response: Get system serial number", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/event/system/poke": { - "subscribe": { - "summary": "Poke robot", - "description": "When robot receives this event, it responds by showing he received the event. This can be by flashing a led. This is useful to see which robot your are controlling.\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/ready/event": { - "subscribe": { - "summary": "event: System ready", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/ready/request": { - "publish": { - "summary": "Get system ready", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/ready/response/{key}": { - "subscribe": { - "summary": "response: System ready", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/hotword/rotation": { - "publish": { - "summary": "Enable hotword rotation", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/hotword/rotation/changed/event": { - "subscribe": { - "summary": "Hotword rotation changed event", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/system/hotword/rotation/get": { - "publish": { - "summary": "Get hotword rotation", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/hotword/rotation/response/{key}": { - "subscribe": { - "summary": "Response: hotword rotation", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/adblogs/upload": { - "publish": { - "summary": "Enable adb logs upload", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/adblogs/changed/event": { - "subscribe": { - "summary": "Adb logs changed event", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/system/adblogs/get": { - "publish": { - "summary": "Get adb logs", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/adblogs/response/{key}": { - "subscribe": { - "summary": "Response: Get adb logs", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/cloud/enable": { - "publish": { - "summary": "Enable cloud broker", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/cloud/enable/changing/event": { - "subscribe": { - "summary": "Cloud broker state is currently changing", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/system/cloud/enable/changed/event": { - "subscribe": { - "summary": "Cloud broker enable changed event", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/system/cloud/enable/get": { - "publish": { - "summary": "Get cloud broker enabled state", - "description": "see <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/cloud/enable/response/{key}": { - "subscribe": { - "summary": "Response: cloud broker enabled state", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/license/get": { - "publish": { - "summary": "Retrieve license information about this robot", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/system/license/response/{key}": { - "subscribe": { - "summary": "response: Retrieve license information about this robot", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "valid_until": { - "type": "number" - }, - "created_timestamp": { - "type": "number" - }, - "status": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "valid", - "expired", - "missing", - "factory" - ] - }, - "valid_from": { - "type": "number" - } - } - }, - "name": "LicenseResult", - "examples": [ - { - "payload": { - "id": "some_id", - "status": "valid", - "valid_until": 1.7764632E9, - "created_timestamp": 1.6187832E9, - "valid_from": 1.6187832E9 - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/system/license/event": { - "subscribe": { - "summary": "event: License information has changed", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "valid_until": { - "type": "number" - }, - "created_timestamp": { - "type": "number" - }, - "status": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "valid", - "expired", - "missing", - "factory" - ] - }, - "valid_from": { - "type": "number" - } - } - }, - "name": "LicenseResult", - "examples": [ - { - "payload": { - "id": "some_id", - "status": "valid", - "valid_until": 1.7764632E9, - "created_timestamp": 1.6187832E9, - "valid_from": 1.6187832E9 - } - } - ] - } - } - }, - "zbos/cloud/broker/status/event": { - "subscribe": { - "summary": "event: Broker status", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "connected": { - "type": "boolean" - }, - "graceful": { - "type": "boolean" - } - } - }, - "name": "BrokerStatus", - "examples": [ - { - "payload": { - "connected": true, - "graceful": true - } - } - ] - } - } - }, - "zbos/system/multimedia/rename": { - "publish": { - "summary": "Rename file", - "description": "Rename a multimedia filesee <> for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of existing file" - }, - "name": { - "type": "string", - "description": "New name of file with extension" - } - } - }, - "name": "RenameRequest", - "examples": [ - { - "payload": { - "path": "string", - "name": "string" - } - } - ] - } - } - }, - "zbos/system/multimedia/rename/response": { - "subscribe": { - "summary": "response: Rename file", - "description": "", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - } - }, - "zbos/system/multimedia/delete/request": { - "publish": { - "summary": "Remove a file from the robot", - "description": "Removes a file from the robot; limited to files inside of the zbos_media_library directory.see zbos/system/multimedia/delete/response/{key} for response\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "path": { - "type": "string" - } - } - }, - "name": "DeleteRequest", - "examples": [ - { - "payload": { - "path": "string" - } - } - ] - } - } - }, - "zbos/system/multimedia/delete/response/{key}": { - "subscribe": { - "summary": "response: Remove a file from the robot", - "description": "Result if file is successfully deleted\n", - "tags": [ - { - "name": "System", - "description": "All system related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "error": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "ordinal": { - "type": "integer" - } - }, - "enum": [ - "FILE_NOT_EXIST", - "NOT_PERMITTED", - "FAILED" - ] - } - } - }, - "name": "DeleteResponse", - "examples": [ - { - "payload": { - "success": false, - "error": "FILE_NOT_EXIST" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/time/info/get": { - "publish": { - "summary": "Get Time information, such as the accuracy", - "description": "see <> for response\n", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/time/info/response/{key}": { - "subscribe": { - "summary": "response: Time information", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "accurate": { - "type": "boolean" - } - } - }, - "name": "TimeInfo", - "examples": [ - { - "payload": { - "accurate": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/quiet/hours": { - "publish": { - "summary": "Quiet hours", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/scheduler/save": { - "publish": { - "summary": "Save schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/scheduler/save/event": { - "subscribe": { - "summary": "event: Schedule saved", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleScheduler", - "examples": [ - { - "payload": { - "id": "string", - "name": "string" - } - } - ] - } - } - }, - "zbos/scheduler/load": { - "publish": { - "summary": "Get schedule", - "description": "see <> for response\n", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleScheduler", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/scheduler/load/response/{key}": { - "subscribe": { - "summary": "response: Get schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/scheduler/delete": { - "publish": { - "summary": "Delete schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleScheduler", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/scheduler/delete/event": { - "subscribe": { - "summary": "event: Schedule deleted", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/scheduler/list/get": { - "publish": { - "summary": "Get all schedules", - "description": "see <> for response\n", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/scheduler/list/response/{key}": { - "subscribe": { - "summary": "response: Get all schedules", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - }, - "name": "Array", - "examples": [ - { - "payload": { - "id": "string", - "name": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/scheduler/start": { - "publish": { - "summary": "Start schedule by name", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleScheduler", - "examples": [ - { - "payload": { - "name": "string" - } - } - ] - } - } - }, - "zbos/scheduler/start/event": { - "subscribe": { - "summary": "event: Started schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/scheduler/start/id": { - "publish": { - "summary": "Start schedule by id", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - }, - "name": "SimpleScheduler", - "examples": [ - { - "payload": { - "id": "string" - } - } - ] - } - } - }, - "zbos/scheduler/stop": { - "publish": { - "summary": "Stop schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/scheduler/stop/event": { - "subscribe": { - "summary": "event: Schedule stopped", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - } - }, - "zbos/scheduler/current/get": { - "publish": { - "summary": "Get current schedule", - "description": "see <> for response\n", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/scheduler/current/get/response/{key}": { - "subscribe": { - "summary": "response: Get current schedule", - "description": "", - "tags": [ - { - "name": "Time", - "description": "All time related topics." - } - ], - "message": { - "payload": { - "type": "string" - }, - "name": "String" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/translations/get": { - "publish": { - "summary": "Get translations", - "description": "Get translations for the provided category and language.\nYou have two ways to get the translations: either pass the category + the corresponding keys,\nor only pass the keys, but prefix each one with the category and a dot. Eg: {category}.{key}\n\n", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string", - "description": "Optional when using the dot notation in the translations keys." - }, - "language": { - "type": "string", - "description": "ISO 639-1 language code, Eg: 'en' or 'en-US'" - }, - "translation_keys": { - "type": "array", - "description": "Optional if the category is set. In that case it will return all translations for that category.", - "items": { - "type": "string" - } - } - } - }, - "name": "GetTranslationsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US" - } - }, - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "translation_keys": [ - "translation_key_1", - "translation_key_2" - ] - } - }, - { - "payload": { - "key": "abc", - "language": "en-US", - "translation_keys": [ - "category_1.translation_key_1", - "category_1.translation_key_2" - ] - } - } - ] - } - } - }, - "zbos/translations/get/response/{key}": { - "publish": { - "summary": "Response: Get translations", - "description": "", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "translations": { - "type": "object" - } - } - }, - "name": "GetTranslationsResponse", - "examples": [ - { - "payload": { - "translations": { - "translation_key_1": "Translation 1", - "translation_key_2": "Translation 2" - }, - "valid": true - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/translations/request": { - "publish": { - "summary": "Request translation registrations", - "description": "Request all translation providers to register their translations using the topics below.\n", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "$ref": "#/components/messages/emptyMessage" - } - } - }, - "zbos/translations/add": { - "publish": { - "summary": "Add translations", - "description": "Add translations with their default values.\nThese default values will be used as long as they are not updated via zbos/translations/update\n", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string" - }, - "language": { - "type": "string", - "description": "ISO 639-1 language code, Eg: 'en' or 'en-US'" - }, - "file": { - "type": "string", - "description": "Optional. Use either translations or file.\nThe file location should be a path accessible for the RAIL.\nThe content should be a json object with key-value pairs.\nDots (.) are not allowed in the keys and will be replaced with underscores (_)\"" - }, - "translations": { - "type": "object", - "description": "Optional. Use either translations or file\nDots (.) are not allowed in the keys and will be replaced with underscores (_)" - } - } - }, - "name": "AddTranslationsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "translations": { - "translation_key_1": "Translation 1", - "translation_key_2": "Translation 2" - }, - "valid": true - } - }, - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "file": "path/to/file.json", - "valid": true - } - } - ] - } - } - }, - "zbos/translations/add/response/{key}": { - "publish": { - "summary": "Response: Add translations", - "description": "", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/translations/update": { - "publish": { - "summary": "Update translations", - "description": "Update translations overriding the default values.\n", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string" - }, - "language": { - "type": "string", - "description": "ISO 639-1 language code, Eg: 'en' or 'en-US'" - }, - "file": { - "type": "string", - "description": "Optional. Use either translations or file.\nThe file location should be a path accessible for the RAIL.\nThe content should be a json object with key-value pairs." - }, - "translations": { - "type": "object", - "description": "Optional. Use either translations or file" - } - } - }, - "name": "UpdateTranslationsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "translations": { - "translation_key_1": "Translation 1", - "translation_key_2": "Translation 2" - }, - "valid": true - } - }, - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "file": "path/to/file.json", - "valid": true - } - } - ] - } - } - }, - "zbos/translations/update/response/{key}": { - "publish": { - "summary": "Response: Update translations", - "description": "", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/translations/changed/event/{category}": { - "publish": { - "summary": "Event: Translations changed", - "description": "", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "language": { - "type": "string", - "description": "ISO 639-1 language code, Eg: 'en' or 'en-US'" - } - } - }, - "name": "TranslationsChangedEvent", - "examples": [ - { - "payload": { - "category": "category_1", - "language": "en-US", - "valid": true - } - } - ] - } - }, - "parameters": { - "category": { - "description": "ID of the translations category that was changed", - "schema": { - "type": "string" - } - } - } - }, - "zbos/translations/reset": { - "publish": { - "summary": "Reset translations", - "description": "Reset translations to their default values\n", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "category": { - "type": "string" - }, - "language": { - "type": "string", - "description": "ISO 639-1 language code, Eg: 'en' or 'en-US'" - } - } - }, - "name": "ResetTranslationsRequest", - "examples": [ - { - "payload": { - "key": "abc", - "category": "category_1", - "language": "en-US", - "valid": true - } - } - ] - } - } - }, - "zbos/translations/reset/response/{key}": { - "publish": { - "summary": "Response: Reset translations", - "description": "", - "tags": [ - { - "name": "Translations", - "description": "All translations related topics." - } - ], - "message": { - "$ref": "#/components/messages/successMessage" - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/variables/get": { - "publish": { - "summary": "Get all variables", - "description": "see <> for response\n", - "tags": [ - { - "name": "Variables", - "description": "All variables related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/variables/response/{key}": { - "subscribe": { - "summary": "response: Get all variables", - "description": "", - "tags": [ - { - "name": "Variables", - "description": "All variables related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "variables": { - "type": "array", - "description": "A list of all variables, not present when status is false.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - }, - "id": { - "type": "string" - }, - "state": { - "type": "string" - } - } - } - }, - "status": { - "type": "boolean", - "description": "Will be present when status is false (error message)" - }, - "message": { - "type": "string" - } - } - }, - "name": "GlobalVariables", - "examples": [ - { - "payload": { - "variables": [ - { - "name": "string", - "value": "string" - } - ], - "status": true, - "message": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - }, - "zbos/variables/set": { - "publish": { - "summary": "Set variables", - "description": "Saving the global variables on the robot.see <> for response\n", - "tags": [ - { - "name": "Variables", - "description": "All variables related topics." - } - ], - "message": { - "$ref": "#/components/messages/keyMessage" - } - } - }, - "zbos/variables/set/response/{key}": { - "subscribe": { - "summary": "response: indicates if the save was successful or not", - "description": "", - "tags": [ - { - "name": "Variables", - "description": "All variables related topics." - } - ], - "message": { - "payload": { - "type": "object", - "properties": { - "variables": { - "type": "array", - "description": "A list of all variables, not present when status is false.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - }, - "id": { - "type": "string" - }, - "state": { - "type": "string" - } - } - } - }, - "status": { - "type": "boolean", - "description": "Will be present when status is false (error message)" - }, - "message": { - "type": "string" - } - } - }, - "name": "GlobalVariables", - "examples": [ - { - "payload": { - "variables": [ - { - "name": "string", - "value": "string" - } - ], - "status": true, - "message": "string" - } - } - ] - } - }, - "parameters": { - "key": { - "description": "Request key to create a unique subscription topic", - "schema": { - "type": "string" - } - } - } - } - }, - "components": { - "schemas": { - "percentage": { - "type": "integer", - "maximum": 100, - "minimum": 0, - "description": "Percentage value between with range 0 to 100" - }, - "key": { - "type": "string", - "description": "Required random key" - } - }, - "messages": { - "emptyMessage": { - "payload": { - "type": "object" - }, - "name": "EmptyMessage", - "summary": "Empty message" - }, - "keyMessage": { - "payload": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Required random key" - } - } - }, - "name": "KeyResult", - "summary": "Random key", - "examples": [ - { - "payload": { - "key": "ABCxyz" - } - } - ] - }, - "successMessage": { - "payload": { - "type": "object", - "properties": { - "success": { - "type": "boolean" - }, - "message": { - "type": "string", - "description": "Optional error message" - } - } - }, - "name": "SuccessMessage", - "summary": "Success message", - "examples": [ - { - "payload": { - "success": true - } - } - ] - }, - "notificationMessage": { - "payload": { - "type": "object", - "properties": { - "message": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "translate": { - "type": "boolean" - }, - "formatArguments": { - "type": "array", - "items": { - "type": "string" - } - }, - "translationCategory": { - "type": "string" - } - } - } - } - }, - "name": "NotificationOptions", - "summary": "Message json", - "examples": [ - { - "payload": { - "message": { - "message": "string", - "translate": true, - "formatArguments": [ - "string" - ] - } - } - } - ] - } - } - }, - "tags": [ - { - "name": "Speech", - "description": "All speech related topics." - }, - { - "name": "Motion", - "description": "All motion related topics." - }, - { - "name": "Audio", - "description": "All audio related topics." - }, - { - "name": "Status", - "description": "All status related topics." - }, - { - "name": "System", - "description": "All system related topics." - }, - { - "name": "Sensors", - "description": "All sensors related topics." - }, - { - "name": "Leds", - "description": "All leds related topics." - }, - { - "name": "Composer", - "description": "All composer related topics." - }, - { - "name": "Kiosk", - "description": "All kiosk related topics." - }, - { - "name": "Media", - "description": "All media related topics." - }, - { - "name": "Applications", - "description": "All applications related topics." - }, - { - "name": "Translations", - "description": "All translations related topics." - }, - { - "name": "Settings", - "description": "All settings related topics." - }, - { - "name": "Camera", - "description": "All camera related topics." - }, - { - "name": "Domotics", - "description": "All domotics related topics." - }, - { - "name": "Cloud", - "description": "All cloud related topics." - }, - { - "name": "SLAM", - "description": "All slam related topics." - }, - { - "name": "Wifi", - "description": "All wifi related topics." - }, - { - "name": "Connection", - "description": "All connection related topics." - }, - { - "name": "Survey", - "description": "All survey related topics." - }, - { - "name": "Motion detection", - "description": "All motion detection related topics." - }, - { - "name": "Face tracking", - "description": "All face tracking related topics." - }, - { - "name": "SIP", - "description": "All sip related topics." - }, - { - "name": "Time", - "description": "All time related topics." - }, - { - "name": "Variables", - "description": "All variables related topics." - }, - { - "name": "Diagnostics", - "description": "All diagnostics related topics." - } - ] - } \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_1/dummy.json b/test/blackbox/docs/AsyncAPI-2_1/dummy.json deleted file mode 100644 index 3b19bde39e..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_1/dummy.json +++ /dev/null @@ -1,571 +0,0 @@ -{ - "asyncapi": "2.1.0", - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.com" - }, - "info": { - "title": "Dummy example with all spec features included", - "version": "0.0.1", - "description": "This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.\n\nIt's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - }, - "contact": { - "name": "API Support", - "url": "http://www.asyncapi.com/support", - "email": "info@asyncapi.io" - }, - "x-twitter": "@AsyncAPISpec" - }, - "tags": [ - { - "name": "root-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag3" - }, - { - "name": "root-tag4", - "description": "Description 4" - }, - { - "name": "root-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "servers": { - "dummy-mqtt": { - "url": "mqtt://localhost", - "protocol": "mqtt", - "description": "dummy MQTT broker", - "bindings": { - "mqtt": { - "clientId": "guest", - "cleanSession": true - } - } - }, - "dummy-amqp": { - "url": "amqp://localhost:{port}", - "protocol": "amqp", - "description": "dummy AMQP broker", - "protocolVersion": "0.9.1", - "variables": { - "port": { - "enum": [ - "15672", - "5672" - ] - } - }, - "security": [ - { - "user-password": [] - } - ] - }, - "dummy-kafka": { - "url": "http://localhost:{port}", - "protocol": "kafka", - "description": "dummy Kafka broker", - "variables": { - "port": { - "default": "9092" - } - } - } - }, - "defaultContentType": "application/json", - "channels": { - "dummy/channel/with/{dummy}/parameter/create": { - "x-dummy-security": { - "$ref": "#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials" - }, - "description": "Dummy channel description.", - "parameters": { - "dummy": { - "$ref": "#/components/parameters/dummy" - } - }, - "publish": { - "summary": "Inform whenever something dummy is created.", - "description": "Longer description.\n\nStill dummy though.\n", - "operationId": "receiveNewDummyInfo", - "tags": [ - { - "name": "oparation-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag3" - }, - { - "name": "oparation-tag4", - "description": "Description 4" - }, - { - "name": "oparation-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dummyCreated" - } - } - }, - "dummy/channel/without/parameter": { - "bindings": { - "amqp": { - "is": "routingKey" - } - }, - "subscribe": { - "operationId": "receiveSystemInfo", - "bindings": { - "amqp": { - "expiration": 100000, - "userId": "guest", - "cc": [ - "user.logs" - ], - "priority": 10, - "deliveryMode": 2, - "mandatory": false, - "bcc": [ - "external.audit" - ], - "replyTo": "user.signedup", - "timestamp": true, - "ack": false, - "bindingVersion": "0.1.0" - } - }, - "message": { - "$ref": "#/components/messages/dummyInfo" - } - } - } - }, - "components": { - "messages": { - "dummyCreated": { - "name": "dummyCreated", - "title": "Dummy created message", - "summary": "This is just a dummy create message", - "correlationId": { - "description": "This is a dummy correlation ID.", - "location": "$message.header#/correlationId" - }, - "tags": [ - { - "name": "message-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag3" - }, - { - "name": "message-tag4", - "description": "Description 4" - }, - { - "name": "message-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "headers": { - "type": "object", - "properties": { - "my-custom-app-header": { - "type": "string" - }, - "correlationId": { - "type": "string" - } - } - }, - "payload": { - "$ref": "#/components/schemas/dummyCreated" - }, - "bindings": { - "kafka": { - "key": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "type1", - "type2" - ] - } - } - }, - "bindingVersion": "0.1.0" - }, - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.1.0" - } - }, - "x-response": { - "$ref": "#/components/messages/dummyInfo" - } - }, - "dummyInfo": { - "name": "dummyInfo", - "title": "Dummy system info", - "summary": "This is just a dummy info message", - "correlationId": { - "location": "$message.header#/correlationId" - }, - "description": "More description for a dummy message.\n\nIt is a dummy system info message.\n", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dummyInfo" - }, - "examples": [ - { - "name": "option1example", - "summary": "this is dummy summary for option1example", - "headers": { - "my-app-header": 12 - }, - "payload": { - "prop1": "option1", - "sentAt": "2020-01-31T13:24:53.000Z" - } - }, - { - "name": "headerExample", - "headers": { - "my-app-header": 13 - } - }, - { - "payload": { - "prop1": "option2", - "sentAt": "2020-01-31T13:24:53.000Z" - } - } - ] - } - }, - "schemas": { - "dummyCreated": { - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/components/schemas/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/components/schemas/dummyArrayWithArray" - }, - "dummyObject": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyArrayRank": { - "$ref": "#/components/schemas/dummyArrayRank" - } - } - }, - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/components/schemas/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/components/schemas/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - }, - "dummyArrayRank": { - "type": "object", - "properties": { - "dummyArrayValueRank": { - "$ref": "#/components/schemas/dummyArrayValueRank" - }, - "dummyArrayDimensions": { - "$ref": "#/components/schemas/dummyArrayArrayDimensions" - } - } - }, - "dummyArrayValueRank": { - "description": "This Attribute indicates whether the val Attribute of the datapoint is an array and how many dimensions the array has.\n", - "type": "integer", - "default": -1, - "examples": [ - 2 - ], - "oneOf": [ - { - "const": -1, - "description": "Scalar: The value is not an array." - }, - { - "const": 0, - "description": "OneOrMoreDimensions: The value is an array with one or more dimensions." - }, - { - "const": 1, - "description": "OneDimension: The value is an array with one dimension." - }, - { - "const": 2, - "description": "The value is an array with two dimensions." - } - ] - }, - "dummyArrayArrayDimensions": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0 - }, - "examples": [ - [ - 3, - 5 - ] - ] - } - }, - "securitySchemes": { - "user-password": { - "type": "userPassword" - }, - "apiKey": { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - }, - "supportedOauthFlows": { - "type": "oauth2", - "description": "Flows to support OAuth 2.0", - "flows": { - "implicit": { - "authorizationUrl": "https://authserver.example/auth", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "password": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "clientCredentials": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "authorizationCode": { - "authorizationUrl": "https://authserver.example/auth", - "tokenUrl": "https://authserver.example/token", - "refreshUrl": "https://authserver.example/refresh", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - } - } - }, - "openIdConnectWellKnown": { - "type": "openIdConnect", - "openIdConnectUrl": "https://authserver.example/.well-known" - } - }, - "parameters": { - "dummy": { - "description": "The ID of the new dummy message.", - "schema": { - "type": "string", - "description": "Description that not be rendered, as parameter has explicit description." - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - "correlationId": { - "type": "string" - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "groupId": "my-app-group-id", - "clientId": "my-app-client-id", - "bindingVersion": "0.1.0" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_2/dummy.json b/test/blackbox/docs/AsyncAPI-2_2/dummy.json deleted file mode 100644 index 326cddeb01..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_2/dummy.json +++ /dev/null @@ -1,574 +0,0 @@ -{ - "asyncapi": "2.2.0", - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.com" - }, - "info": { - "title": "Dummy example with all spec features included", - "version": "0.0.1", - "description": "This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.\n\nIt's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - }, - "contact": { - "name": "API Support", - "url": "http://www.asyncapi.com/support", - "email": "info@asyncapi.io" - }, - "x-twitter": "@AsyncAPISpec" - }, - "tags": [ - { - "name": "root-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag3" - }, - { - "name": "root-tag4", - "description": "Description 4" - }, - { - "name": "root-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "servers": { - "dummy-mqtt": { - "url": "mqtt://localhost", - "protocol": "mqtt", - "description": "dummy MQTT broker", - "bindings": { - "mqtt": { - "clientId": "guest", - "cleanSession": true - } - } - }, - "dummy-amqp": { - "url": "amqp://localhost:{port}", - "protocol": "amqp", - "description": "dummy AMQP broker", - "protocolVersion": "0.9.1", - "variables": { - "port": { - "enum": [ - "15672", - "5672" - ] - } - }, - "security": [ - { - "user-password": [] - } - ] - }, - "dummy-kafka": { - "url": "http://localhost:{port}", - "protocol": "kafka", - "description": "dummy Kafka broker", - "variables": { - "port": { - "default": "9092" - } - } - } - }, - "defaultContentType": "application/json", - "channels": { - "dummy/channel/with/{dummy}/parameter/create": { - "servers": [ - "dummy-kafka" - ], - "x-dummy-security": { - "$ref": "#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials" - }, - "description": "Dummy channel description.", - "parameters": { - "dummy": { - "$ref": "#/components/parameters/dummy" - } - }, - "publish": { - "summary": "Inform whenever something dummy is created.", - "description": "Longer description.\n\nStill dummy though.\n", - "operationId": "receiveNewDummyInfo", - "tags": [ - { - "name": "oparation-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag3" - }, - { - "name": "oparation-tag4", - "description": "Description 4" - }, - { - "name": "oparation-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dummyCreated" - } - } - }, - "dummy/channel/without/parameter": { - "bindings": { - "amqp": { - "is": "routingKey" - } - }, - "subscribe": { - "operationId": "receiveSystemInfo", - "bindings": { - "amqp": { - "expiration": 100000, - "userId": "guest", - "cc": [ - "user.logs" - ], - "priority": 10, - "deliveryMode": 2, - "mandatory": false, - "bcc": [ - "external.audit" - ], - "replyTo": "user.signedup", - "timestamp": true, - "ack": false, - "bindingVersion": "0.1.0" - } - }, - "message": { - "$ref": "#/components/messages/dummyInfo" - } - } - } - }, - "components": { - "messages": { - "dummyCreated": { - "name": "dummyCreated", - "title": "Dummy created message", - "summary": "This is just a dummy create message", - "correlationId": { - "description": "This is a dummy correlation ID.", - "location": "$message.header#/correlationId" - }, - "tags": [ - { - "name": "message-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag3" - }, - { - "name": "message-tag4", - "description": "Description 4" - }, - { - "name": "message-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "headers": { - "type": "object", - "properties": { - "my-custom-app-header": { - "type": "string" - }, - "correlationId": { - "type": "string" - } - } - }, - "payload": { - "$ref": "#/components/schemas/dummyCreated" - }, - "bindings": { - "kafka": { - "key": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "type1", - "type2" - ] - } - } - }, - "bindingVersion": "0.1.0" - }, - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.1.0" - } - }, - "x-response": { - "$ref": "#/components/messages/dummyInfo" - } - }, - "dummyInfo": { - "name": "dummyInfo", - "title": "Dummy system info", - "summary": "This is just a dummy info message", - "correlationId": { - "location": "$message.header#/correlationId" - }, - "description": "More description for a dummy message.\n\nIt is a dummy system info message.\n", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dummyInfo" - }, - "examples": [ - { - "name": "option1example", - "summary": "this is dummy summary for option1example", - "headers": { - "my-app-header": 12 - }, - "payload": { - "prop1": "option1", - "sentAt": "2020-01-31T13:24:53.000Z" - } - }, - { - "name": "headerExample", - "headers": { - "my-app-header": 13 - } - }, - { - "payload": { - "prop1": "option2", - "sentAt": "2020-01-31T13:24:53.000Z" - } - } - ] - } - }, - "schemas": { - "dummyCreated": { - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/components/schemas/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/components/schemas/dummyArrayWithArray" - }, - "dummyObject": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyArrayRank": { - "$ref": "#/components/schemas/dummyArrayRank" - } - } - }, - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/components/schemas/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/components/schemas/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - }, - "dummyArrayRank": { - "type": "object", - "properties": { - "dummyArrayValueRank": { - "$ref": "#/components/schemas/dummyArrayValueRank" - }, - "dummyArrayDimensions": { - "$ref": "#/components/schemas/dummyArrayArrayDimensions" - } - } - }, - "dummyArrayValueRank": { - "description": "This Attribute indicates whether the val Attribute of the datapoint is an array and how many dimensions the array has.\n", - "type": "integer", - "default": -1, - "examples": [ - 2 - ], - "oneOf": [ - { - "const": -1, - "description": "Scalar: The value is not an array." - }, - { - "const": 0, - "description": "OneOrMoreDimensions: The value is an array with one or more dimensions." - }, - { - "const": 1, - "description": "OneDimension: The value is an array with one dimension." - }, - { - "const": 2, - "description": "The value is an array with two dimensions." - } - ] - }, - "dummyArrayArrayDimensions": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0 - }, - "examples": [ - [ - 3, - 5 - ] - ] - } - }, - "securitySchemes": { - "user-password": { - "type": "userPassword" - }, - "apiKey": { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - }, - "supportedOauthFlows": { - "type": "oauth2", - "description": "Flows to support OAuth 2.0", - "flows": { - "implicit": { - "authorizationUrl": "https://authserver.example/auth", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "password": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "clientCredentials": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "authorizationCode": { - "authorizationUrl": "https://authserver.example/auth", - "tokenUrl": "https://authserver.example/token", - "refreshUrl": "https://authserver.example/refresh", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - } - } - }, - "openIdConnectWellKnown": { - "type": "openIdConnect", - "openIdConnectUrl": "https://authserver.example/.well-known" - } - }, - "parameters": { - "dummy": { - "description": "The ID of the new dummy message.", - "schema": { - "type": "string", - "description": "Description that not be rendered, as parameter has explicit description." - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - "correlationId": { - "type": "string" - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "groupId": "my-app-group-id", - "clientId": "my-app-client-id", - "bindingVersion": "0.1.0" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_3/dummy.json b/test/blackbox/docs/AsyncAPI-2_3/dummy.json deleted file mode 100644 index 3aabc2c527..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_3/dummy.json +++ /dev/null @@ -1,574 +0,0 @@ -{ - "asyncapi": "2.3.0", - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.com" - }, - "info": { - "title": "Dummy example with all spec features included", - "version": "0.0.1", - "description": "This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.\n\nIt's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - }, - "contact": { - "name": "API Support", - "url": "http://www.asyncapi.com/support", - "email": "info@asyncapi.io" - }, - "x-twitter": "@AsyncAPISpec" - }, - "tags": [ - { - "name": "root-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag3" - }, - { - "name": "root-tag4", - "description": "Description 4" - }, - { - "name": "root-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "servers": { - "dummy-mqtt": { - "url": "mqtt://localhost", - "protocol": "mqtt", - "description": "dummy MQTT broker", - "bindings": { - "mqtt": { - "clientId": "guest", - "cleanSession": true - } - } - }, - "dummy-amqp": { - "url": "amqp://localhost:{port}", - "protocol": "amqp", - "description": "dummy AMQP broker", - "protocolVersion": "0.9.1", - "variables": { - "port": { - "enum": [ - "15672", - "5672" - ] - } - }, - "security": [ - { - "user-password": [] - } - ] - }, - "dummy-kafka": { - "url": "http://localhost:{port}", - "protocol": "kafka", - "description": "dummy Kafka broker", - "variables": { - "port": { - "default": "9092" - } - } - } - }, - "defaultContentType": "application/json", - "channels": { - "dummy/channel/with/{dummy}/parameter/create": { - "servers": [ - "dummy-kafka" - ], - "x-dummy-security": { - "$ref": "#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials" - }, - "description": "Dummy channel description.", - "parameters": { - "dummy": { - "$ref": "#/components/parameters/dummy" - } - }, - "publish": { - "summary": "Inform whenever something dummy is created.", - "description": "Longer description.\n\nStill dummy though.\n", - "operationId": "receiveNewDummyInfo", - "tags": [ - { - "name": "oparation-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag3" - }, - { - "name": "oparation-tag4", - "description": "Description 4" - }, - { - "name": "oparation-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dummyCreated" - } - } - }, - "dummy/channel/without/parameter": { - "bindings": { - "amqp": { - "is": "routingKey" - } - }, - "subscribe": { - "operationId": "receiveSystemInfo", - "bindings": { - "amqp": { - "expiration": 100000, - "userId": "guest", - "cc": [ - "user.logs" - ], - "priority": 10, - "deliveryMode": 2, - "mandatory": false, - "bcc": [ - "external.audit" - ], - "replyTo": "user.signedup", - "timestamp": true, - "ack": false, - "bindingVersion": "0.1.0" - } - }, - "message": { - "$ref": "#/components/messages/dummyInfo" - } - } - } - }, - "components": { - "messages": { - "dummyCreated": { - "name": "dummyCreated", - "title": "Dummy created message", - "summary": "This is just a dummy create message", - "correlationId": { - "description": "This is a dummy correlation ID.", - "location": "$message.header#/correlationId" - }, - "tags": [ - { - "name": "message-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag3" - }, - { - "name": "message-tag4", - "description": "Description 4" - }, - { - "name": "message-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "headers": { - "type": "object", - "properties": { - "my-custom-app-header": { - "type": "string" - }, - "correlationId": { - "type": "string" - } - } - }, - "payload": { - "$ref": "#/components/schemas/dummyCreated" - }, - "bindings": { - "kafka": { - "key": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "type1", - "type2" - ] - } - } - }, - "bindingVersion": "0.1.0" - }, - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.1.0" - } - }, - "x-response": { - "$ref": "#/components/messages/dummyInfo" - } - }, - "dummyInfo": { - "name": "dummyInfo", - "title": "Dummy system info", - "summary": "This is just a dummy info message", - "correlationId": { - "location": "$message.header#/correlationId" - }, - "description": "More description for a dummy message.\n\nIt is a dummy system info message.\n", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dummyInfo" - }, - "examples": [ - { - "name": "option1example", - "summary": "this is dummy summary for option1example", - "headers": { - "my-app-header": 12 - }, - "payload": { - "prop1": "option1", - "sentAt": "2020-01-31T13:24:53.000Z" - } - }, - { - "name": "headerExample", - "headers": { - "my-app-header": 13 - } - }, - { - "payload": { - "prop1": "option2", - "sentAt": "2020-01-31T13:24:53.000Z" - } - } - ] - } - }, - "schemas": { - "dummyCreated": { - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/components/schemas/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/components/schemas/dummyArrayWithArray" - }, - "dummyObject": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyArrayRank": { - "$ref": "#/components/schemas/dummyArrayRank" - } - } - }, - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/components/schemas/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/components/schemas/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - }, - "dummyArrayRank": { - "type": "object", - "properties": { - "dummyArrayValueRank": { - "$ref": "#/components/schemas/dummyArrayValueRank" - }, - "dummyArrayDimensions": { - "$ref": "#/components/schemas/dummyArrayArrayDimensions" - } - } - }, - "dummyArrayValueRank": { - "description": "This Attribute indicates whether the val Attribute of the datapoint is an array and how many dimensions the array has.\n", - "type": "integer", - "default": -1, - "examples": [ - 2 - ], - "oneOf": [ - { - "const": -1, - "description": "Scalar: The value is not an array." - }, - { - "const": 0, - "description": "OneOrMoreDimensions: The value is an array with one or more dimensions." - }, - { - "const": 1, - "description": "OneDimension: The value is an array with one dimension." - }, - { - "const": 2, - "description": "The value is an array with two dimensions." - } - ] - }, - "dummyArrayArrayDimensions": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0 - }, - "examples": [ - [ - 3, - 5 - ] - ] - } - }, - "securitySchemes": { - "user-password": { - "type": "userPassword" - }, - "apiKey": { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - }, - "supportedOauthFlows": { - "type": "oauth2", - "description": "Flows to support OAuth 2.0", - "flows": { - "implicit": { - "authorizationUrl": "https://authserver.example/auth", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "password": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "clientCredentials": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "authorizationCode": { - "authorizationUrl": "https://authserver.example/auth", - "tokenUrl": "https://authserver.example/token", - "refreshUrl": "https://authserver.example/refresh", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - } - } - }, - "openIdConnectWellKnown": { - "type": "openIdConnect", - "openIdConnectUrl": "https://authserver.example/.well-known" - } - }, - "parameters": { - "dummy": { - "description": "The ID of the new dummy message.", - "schema": { - "type": "string", - "description": "Description that not be rendered, as parameter has explicit description." - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - "correlationId": { - "type": "string" - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "groupId": "my-app-group-id", - "clientId": "my-app-client-id", - "bindingVersion": "0.1.0" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_4/dummy.json b/test/blackbox/docs/AsyncAPI-2_4/dummy.json deleted file mode 100644 index bb37a294b0..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_4/dummy.json +++ /dev/null @@ -1,574 +0,0 @@ -{ - "asyncapi": "2.4.0", - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.com" - }, - "info": { - "title": "Dummy example with all spec features included", - "version": "0.0.1", - "description": "This is an example of AsyncAPI specification file that is suppose to include all possible features of the AsyncAPI specification. Do not use it on production.\n\nIt's goal is to support development of documentation and code generation with the [AsyncAPI Generator](https://github.com/asyncapi/generator/) and [Template projects](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate)\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - }, - "contact": { - "name": "API Support", - "url": "http://www.asyncapi.com/support", - "email": "info@asyncapi.io" - }, - "x-twitter": "@AsyncAPISpec" - }, - "tags": [ - { - "name": "root-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "root-tag3" - }, - { - "name": "root-tag4", - "description": "Description 4" - }, - { - "name": "root-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "servers": { - "dummy-mqtt": { - "url": "mqtt://localhost", - "protocol": "mqtt", - "description": "dummy MQTT broker", - "bindings": { - "mqtt": { - "clientId": "guest", - "cleanSession": true - } - } - }, - "dummy-amqp": { - "url": "amqp://localhost:{port}", - "protocol": "amqp", - "description": "dummy AMQP broker", - "protocolVersion": "0.9.1", - "variables": { - "port": { - "enum": [ - "15672", - "5672" - ] - } - }, - "security": [ - { - "user-password": [] - } - ] - }, - "dummy-kafka": { - "url": "http://localhost:{port}", - "protocol": "kafka", - "description": "dummy Kafka broker", - "variables": { - "port": { - "default": "9092" - } - } - } - }, - "defaultContentType": "application/json", - "channels": { - "dummy/channel/with/{dummy}/parameter/create": { - "servers": [ - "dummy-kafka" - ], - "x-dummy-security": { - "$ref": "#/components/securitySchemes/supportedOauthFlows/flows/clientCredentials" - }, - "description": "Dummy channel description.", - "parameters": { - "dummy": { - "$ref": "#/components/parameters/dummy" - } - }, - "publish": { - "summary": "Inform whenever something dummy is created.", - "description": "Longer description.\n\nStill dummy though.\n", - "operationId": "receiveNewDummyInfo", - "tags": [ - { - "name": "oparation-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "oparation-tag3" - }, - { - "name": "oparation-tag4", - "description": "Description 4" - }, - { - "name": "oparation-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dummyCreated" - } - } - }, - "dummy/channel/without/parameter": { - "bindings": { - "amqp": { - "is": "routingKey" - } - }, - "subscribe": { - "operationId": "receiveSystemInfo", - "bindings": { - "amqp": { - "expiration": 100000, - "userId": "guest", - "cc": [ - "user.logs" - ], - "priority": 10, - "deliveryMode": 2, - "mandatory": false, - "bcc": [ - "external.audit" - ], - "replyTo": "user.signedup", - "timestamp": true, - "ack": false, - "bindingVersion": "0.1.0" - } - }, - "message": { - "$ref": "#/components/messages/dummyInfo" - } - } - } - }, - "components": { - "messages": { - "dummyCreated": { - "name": "dummyCreated", - "title": "Dummy created message", - "summary": "This is just a dummy create message", - "correlationId": { - "description": "This is a dummy correlation ID.", - "location": "$message.header#/correlationId" - }, - "tags": [ - { - "name": "message-tag1", - "externalDocs": { - "description": "External docs description 1", - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag2", - "description": "Description 2", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - }, - { - "name": "message-tag3" - }, - { - "name": "message-tag4", - "description": "Description 4" - }, - { - "name": "message-tag5", - "externalDocs": { - "url": "https://www.asyncapi.com/" - } - } - ], - "headers": { - "type": "object", - "properties": { - "my-custom-app-header": { - "type": "string" - }, - "correlationId": { - "type": "string" - } - } - }, - "payload": { - "$ref": "#/components/schemas/dummyCreated" - }, - "bindings": { - "kafka": { - "key": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "type1", - "type2" - ] - } - } - }, - "bindingVersion": "0.1.0" - }, - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.1.0" - } - }, - "x-response": { - "$ref": "#/components/messages/dummyInfo" - } - }, - "dummyInfo": { - "name": "dummyInfo", - "title": "Dummy system info", - "summary": "This is just a dummy info message", - "correlationId": { - "location": "$message.header#/correlationId" - }, - "description": "More description for a dummy message.\n\nIt is a dummy system info message.\n", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dummyInfo" - }, - "examples": [ - { - "name": "option1example", - "summary": "this is dummy summary for option1example", - "headers": { - "my-app-header": 12 - }, - "payload": { - "prop1": "option1", - "sentAt": "2020-01-31T13:24:53.000Z" - } - }, - { - "name": "headerExample", - "headers": { - "my-app-header": 13 - } - }, - { - "payload": { - "prop1": "option2", - "sentAt": "2020-01-31T13:24:53.000Z" - } - } - ] - } - }, - "schemas": { - "dummyCreated": { - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/components/schemas/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/components/schemas/dummyArrayWithArray" - }, - "dummyObject": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyArrayRank": { - "$ref": "#/components/schemas/dummyArrayRank" - } - } - }, - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/components/schemas/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/components/schemas/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/components/schemas/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/components/schemas/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - }, - "dummyArrayRank": { - "type": "object", - "properties": { - "dummyArrayValueRank": { - "$ref": "#/components/schemas/dummyArrayValueRank" - }, - "dummyArrayDimensions": { - "$ref": "#/components/schemas/dummyArrayArrayDimensions" - } - } - }, - "dummyArrayValueRank": { - "description": "This Attribute indicates whether the val Attribute of the datapoint is an array and how many dimensions the array has.\n", - "type": "integer", - "default": -1, - "examples": [ - 2 - ], - "oneOf": [ - { - "const": -1, - "description": "Scalar: The value is not an array." - }, - { - "const": 0, - "description": "OneOrMoreDimensions: The value is an array with one or more dimensions." - }, - { - "const": 1, - "description": "OneDimension: The value is an array with one dimension." - }, - { - "const": 2, - "description": "The value is an array with two dimensions." - } - ] - }, - "dummyArrayArrayDimensions": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0 - }, - "examples": [ - [ - 3, - 5 - ] - ] - } - }, - "securitySchemes": { - "user-password": { - "type": "userPassword" - }, - "apiKey": { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - }, - "supportedOauthFlows": { - "type": "oauth2", - "description": "Flows to support OAuth 2.0", - "flows": { - "implicit": { - "authorizationUrl": "https://authserver.example/auth", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "password": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "clientCredentials": { - "tokenUrl": "https://authserver.example/token", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - }, - "authorizationCode": { - "authorizationUrl": "https://authserver.example/auth", - "tokenUrl": "https://authserver.example/token", - "refreshUrl": "https://authserver.example/refresh", - "scopes": { - "dummy:created": "Ability to create dummy message", - "dymmy:read": "Ability to read dummy info" - } - } - } - }, - "openIdConnectWellKnown": { - "type": "openIdConnect", - "openIdConnectUrl": "https://authserver.example/.well-known" - } - }, - "parameters": { - "dummy": { - "description": "The ID of the new dummy message.", - "schema": { - "type": "string", - "description": "Description that not be rendered, as parameter has explicit description." - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - }, - "correlationId": { - "type": "string" - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "groupId": "my-app-group-id", - "clientId": "my-app-client-id", - "bindingVersion": "0.1.0" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_4/streetlights-operation-security.json b/test/blackbox/docs/AsyncAPI-2_4/streetlights-operation-security.json deleted file mode 100644 index 6d197a3e39..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_4/streetlights-operation-security.json +++ /dev/null @@ -1,296 +0,0 @@ -{ - "asyncapi": "2.4.0", - "info": { - "title": "Streetlights Kafka API", - "version": "1.0.0", - "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n### Check out its awesome features:\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - } - }, - "servers": { - "test": { - "url": "test.mykafkacluster.org:8092", - "protocol": "kafka-secure", - "description": "Test broker", - "security": [ - { - "saslScram": [] - } - ] - }, - "test_oauth": { - "url": "test.mykafkacluster.org:8093", - "protocol": "kafka-secure", - "description": "Test port for oauth", - "security": [ - { - "streetlights_auth": [ - "streetlights:write", - "streetlights:read" - ] - } - ] - } - }, - "defaultContentType": "application/json", - "channels": { - "smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured": { - "description": "The topic on which measured values may be produced and consumed.", - "servers": [ - "test" - ], - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "publish": { - "summary": "Inform about environmental lighting conditions of a particular streetlight.", - "operationId": "receiveLightMeasurement", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/lightMeasured" - } - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.turn.on": { - "servers": [ - "test_oauth" - ], - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "turnOn", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/turnOnOff" - }, - "security": [ - { - "streetlights_auth": [ - "streetlights:read" - ] - } - ] - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.turn.off": { - "servers": [ - "test_oauth" - ], - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "turnOff", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/turnOnOff" - }, - "security": [ - { - "streetlights_auth": [ - "streetlights:read" - ] - } - ] - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.dim": { - "servers": [ - "test_oauth" - ], - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "dimLight", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dimLight" - }, - "security": [ - { - "streetlights_auth": [ - "streetlights:read" - ] - } - ] - } - } - }, - "components": { - "messages": { - "lightMeasured": { - "name": "lightMeasured", - "title": "Light measured", - "summary": "Inform about environmental lighting conditions of a particular streetlight.", - "contentType": "application/json", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/lightMeasuredPayload" - } - }, - "turnOnOff": { - "name": "turnOnOff", - "title": "Turn on/off", - "summary": "Command a particular streetlight to turn the lights on or off.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/turnOnOffPayload" - } - }, - "dimLight": { - "name": "dimLight", - "title": "Dim light", - "summary": "Command a particular streetlight to dim the lights.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dimLightPayload" - } - } - }, - "schemas": { - "lightMeasuredPayload": { - "type": "object", - "properties": { - "lumens": { - "type": "integer", - "minimum": 0, - "description": "Light intensity measured in lumens." - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "turnOnOffPayload": { - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "on", - "off" - ], - "description": "Whether to turn on or off the light." - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dimLightPayload": { - "type": "object", - "properties": { - "percentage": { - "type": "integer", - "description": "Percentage to which the light should be dimmed to.", - "minimum": 0, - "maximum": 100 - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - } - }, - "securitySchemes": { - "saslScram": { - "type": "scramSha256", - "description": "Provide your username and password for SASL/SCRAM authentication" - }, - "streetlights_auth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "scopes": { - "streetlights:read": "Scope required for subscribing to channel", - "streetlights:write": "Scope required for publishing to channel" - } - } - } - } - }, - "parameters": { - "streetlightId": { - "description": "The ID of the streetlight.", - "schema": { - "type": "string" - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "clientId": { - "type": "string", - "enum": [ - "my-app-id" - ] - } - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_5/streetlight_kafka.json b/test/blackbox/docs/AsyncAPI-2_5/streetlight_kafka.json deleted file mode 100644 index 1b6b7fc719..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_5/streetlight_kafka.json +++ /dev/null @@ -1,279 +0,0 @@ -{ - "asyncapi": "2.5.0", - "info": { - "title": "Streetlights Kafka API", - "version": "1.0.0", - "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0" - } - }, - "servers": { - "scram-connections": { - "url": "test.mykafkacluster.org:18092", - "protocol": "kafka-secure", - "description": "Test broker secured with scramSha256", - "security": [ - { - "saslScram": [] - } - ], - "tags": [ - { - "name": "env:test-scram", - "description": "This environment is meant for running internal tests through scramSha256" - }, - { - "name": "kind:remote", - "description": "This server is a remote server. Not exposed by the application" - }, - { - "name": "visibility:private", - "description": "This resource is private and only available to certain users" - } - ] - }, - "mtls-connections": { - "url": "test.mykafkacluster.org:28092", - "protocol": "kafka-secure", - "description": "Test broker secured with X509", - "security": [ - { - "certs": [] - } - ], - "tags": [ - { - "name": "env:test-mtls", - "description": "This environment is meant for running internal tests through mtls" - }, - { - "name": "kind:remote", - "description": "This server is a remote server. Not exposed by the application" - }, - { - "name": "visibility:private", - "description": "This resource is private and only available to certain users" - } - ] - } - }, - "defaultContentType": "application/json", - "channels": { - "smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured": { - "description": "The topic on which measured values may be produced and consumed.", - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "publish": { - "summary": "Inform about environmental lighting conditions of a particular streetlight.", - "operationId": "receiveLightMeasurement", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/lightMeasured" - } - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.turn.on": { - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "turnOn", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/turnOnOff" - } - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.turn.off": { - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "turnOff", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/turnOnOff" - } - } - }, - "smartylighting.streetlights.1.0.action.{streetlightId}.dim": { - "parameters": { - "streetlightId": { - "$ref": "#/components/parameters/streetlightId" - } - }, - "subscribe": { - "operationId": "dimLight", - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ], - "message": { - "$ref": "#/components/messages/dimLight" - } - } - } - }, - "components": { - "messages": { - "lightMeasured": { - "name": "lightMeasured", - "title": "Light measured", - "summary": "Inform about environmental lighting conditions of a particular streetlight.", - "contentType": "application/json", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/lightMeasuredPayload" - } - }, - "turnOnOff": { - "name": "turnOnOff", - "title": "Turn on/off", - "summary": "Command a particular streetlight to turn the lights on or off.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/turnOnOffPayload" - } - }, - "dimLight": { - "name": "dimLight", - "title": "Dim light", - "summary": "Command a particular streetlight to dim the lights.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/dimLightPayload" - } - } - }, - "schemas": { - "lightMeasuredPayload": { - "type": "object", - "properties": { - "lumens": { - "type": "integer", - "minimum": 0, - "description": "Light intensity measured in lumens." - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "turnOnOffPayload": { - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "on", - "off" - ], - "description": "Whether to turn on or off the light." - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "dimLightPayload": { - "type": "object", - "properties": { - "percentage": { - "type": "integer", - "description": "Percentage to which the light should be dimmed to.", - "minimum": 0, - "maximum": 100 - }, - "sentAt": { - "$ref": "#/components/schemas/sentAt" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - } - }, - "securitySchemes": { - "saslScram": { - "type": "scramSha256", - "description": "Provide your username and password for SASL/SCRAM authentication" - }, - "certs": { - "type": "X509", - "description": "Download the certificate files from service provider" - } - }, - "parameters": { - "streetlightId": { - "description": "The ID of the streetlight.", - "schema": { - "type": "string" - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "operationTraits": { - "kafka": { - "bindings": { - "kafka": { - "clientId": { - "type": "string", - "enum": [ - "my-app-id" - ] - } - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/AsyncAPI-2_6/dummy.json b/test/blackbox/docs/AsyncAPI-2_6/dummy.json deleted file mode 100644 index 46cfbbd6b8..0000000000 --- a/test/blackbox/docs/AsyncAPI-2_6/dummy.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "asyncapi": "2.6.0", - "info": { - "title": "Account Service", - "version": "1.0.0", - "description": "This service is in charge of processing user signups" - }, - "servers": { - "production": { - "url": "localhost", - "protocol": "pulsar", - "bindings": { - "pulsar": { - "tenant": "contoso", - "bindingVersion": "0.1.0" - } - } - } - }, - "channels": { - "user/signedup": { - "subscribe": { - "message": { - "$ref": "#/components/messages/UserSignedUp" - } - }, - "bindings": { - "pulsar": { - "namespace": "staging", - "persistence": "persistent", - "compaction": 1000, - "geo-replication": [ - "us-east1", - "us-west1" - ], - "retention": { - "time": 7, - "size": 1000 - }, - "ttl": 360, - "deduplication": false, - "bindingVersion": "0.1.0" - } - } - } - }, - "components": { - "messages": { - "UserSignedUp": { - "payload": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "Name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "Email of the user" - }, - "signedUpAt": { - "type": "string", - "format": "date-time", - "description": "Sign-up processed date and time" - }, - "sessionDuration": { - "type": "string", - "format": "time", - "description": "Maximum session duration" - }, - "uniqueUserId": { - "type": "string", - "format": "uuid", - "description": "Unique user id" - } - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/aws-cloudformation.json b/test/blackbox/docs/JsonSchemaDraft-4/aws-cloudformation.json deleted file mode 100644 index e04dba2cb6..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/aws-cloudformation.json +++ /dev/null @@ -1,101252 +0,0 @@ -{ - "$id": "http://json-schema.org/draft-04/schema#", - "additionalProperties": false, - "definitions": { - "AWS::ACMPCA::Certificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiPassthrough": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.ApiPassthrough" - }, - "CertificateAuthorityArn": { - "type": "string" - }, - "CertificateSigningRequest": { - "type": "string" - }, - "SigningAlgorithm": { - "type": "string" - }, - "TemplateArn": { - "type": "string" - }, - "Validity": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Validity" - }, - "ValidityNotBefore": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Validity" - } - }, - "required": [ - "CertificateAuthorityArn", - "CertificateSigningRequest", - "SigningAlgorithm", - "Validity" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ACMPCA::Certificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.ApiPassthrough": { - "additionalProperties": false, - "properties": { - "Extensions": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Extensions" - }, - "Subject": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Subject" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.CertificatePolicyList": { - "additionalProperties": false, - "properties": { - "CertificatePolicyList": { - "items": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.PolicyInformation" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.EdiPartyName": { - "additionalProperties": false, - "properties": { - "NameAssigner": { - "type": "string" - }, - "PartyName": { - "type": "string" - } - }, - "required": [ - "NameAssigner", - "PartyName" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.ExtendedKeyUsage": { - "additionalProperties": false, - "properties": { - "ExtendedKeyUsageObjectIdentifier": { - "type": "string" - }, - "ExtendedKeyUsageType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.ExtendedKeyUsageList": { - "additionalProperties": false, - "properties": { - "ExtendedKeyUsageList": { - "items": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.ExtendedKeyUsage" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.Extensions": { - "additionalProperties": false, - "properties": { - "CertificatePolicies": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.CertificatePolicyList" - }, - "ExtendedKeyUsage": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.ExtendedKeyUsageList" - }, - "KeyUsage": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.KeyUsage" - }, - "SubjectAlternativeNames": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.GeneralNameList" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.GeneralName": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Subject" - }, - "DnsName": { - "type": "string" - }, - "EdiPartyName": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.EdiPartyName" - }, - "IpAddress": { - "type": "string" - }, - "OtherName": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.OtherName" - }, - "RegisteredId": { - "type": "string" - }, - "Rfc822Name": { - "type": "string" - }, - "UniformResourceIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.GeneralNameList": { - "additionalProperties": false, - "properties": { - "GeneralNameList": { - "items": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.GeneralName" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.KeyUsage": { - "additionalProperties": false, - "properties": { - "CRLSign": { - "type": "boolean" - }, - "DataEncipherment": { - "type": "boolean" - }, - "DecipherOnly": { - "type": "boolean" - }, - "DigitalSignature": { - "type": "boolean" - }, - "EncipherOnly": { - "type": "boolean" - }, - "KeyAgreement": { - "type": "boolean" - }, - "KeyCertSign": { - "type": "boolean" - }, - "KeyEncipherment": { - "type": "boolean" - }, - "NonRepudiation": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.OtherName": { - "additionalProperties": false, - "properties": { - "TypeId": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "TypeId", - "Value" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.PolicyInformation": { - "additionalProperties": false, - "properties": { - "CertPolicyId": { - "type": "string" - }, - "PolicyQualifiers": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.PolicyQualifierInfoList" - } - }, - "required": [ - "CertPolicyId" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.PolicyQualifierInfo": { - "additionalProperties": false, - "properties": { - "PolicyQualifierId": { - "type": "string" - }, - "Qualifier": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.Qualifier" - } - }, - "required": [ - "PolicyQualifierId", - "Qualifier" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.PolicyQualifierInfoList": { - "additionalProperties": false, - "properties": { - "PolicyQualifierInfoList": { - "items": { - "$ref": "#/definitions/AWS::ACMPCA::Certificate.PolicyQualifierInfo" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.Qualifier": { - "additionalProperties": false, - "properties": { - "CpsUri": { - "type": "string" - } - }, - "required": [ - "CpsUri" - ], - "type": "object" - }, - "AWS::ACMPCA::Certificate.Subject": { - "additionalProperties": false, - "properties": { - "CommonName": { - "type": "string" - }, - "Country": { - "type": "string" - }, - "DistinguishedNameQualifier": { - "type": "string" - }, - "GenerationQualifier": { - "type": "string" - }, - "GivenName": { - "type": "string" - }, - "Initials": { - "type": "string" - }, - "Locality": { - "type": "string" - }, - "Organization": { - "type": "string" - }, - "OrganizationalUnit": { - "type": "string" - }, - "Pseudonym": { - "type": "string" - }, - "SerialNumber": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Surname": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::Certificate.Validity": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CsrExtensions": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.CsrExtensions" - }, - "KeyAlgorithm": { - "type": "string" - }, - "RevocationConfiguration": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.RevocationConfiguration" - }, - "SigningAlgorithm": { - "type": "string" - }, - "Subject": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.Subject" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "KeyAlgorithm", - "SigningAlgorithm", - "Subject", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ACMPCA::CertificateAuthority" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.AccessDescription": { - "additionalProperties": false, - "properties": { - "AccessLocation": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.GeneralName" - }, - "AccessMethod": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.AccessMethod" - } - }, - "required": [ - "AccessLocation", - "AccessMethod" - ], - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.AccessMethod": { - "additionalProperties": false, - "properties": { - "AccessMethodType": { - "type": "string" - }, - "CustomObjectIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.CrlConfiguration": { - "additionalProperties": false, - "properties": { - "CustomCname": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "ExpirationInDays": { - "type": "number" - }, - "S3BucketName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.CsrExtensions": { - "additionalProperties": false, - "properties": { - "KeyUsage": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.KeyUsage" - }, - "SubjectInformationAccess": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.SubjectInformationAccess" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.EdiPartyName": { - "additionalProperties": false, - "properties": { - "NameAssigner": { - "type": "string" - }, - "PartyName": { - "type": "string" - } - }, - "required": [ - "NameAssigner", - "PartyName" - ], - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.GeneralName": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.Subject" - }, - "DnsName": { - "type": "string" - }, - "EdiPartyName": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.EdiPartyName" - }, - "IpAddress": { - "type": "string" - }, - "OtherName": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.OtherName" - }, - "RegisteredId": { - "type": "string" - }, - "Rfc822Name": { - "type": "string" - }, - "UniformResourceIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.KeyUsage": { - "additionalProperties": false, - "properties": { - "CRLSign": { - "type": "boolean" - }, - "DataEncipherment": { - "type": "boolean" - }, - "DecipherOnly": { - "type": "boolean" - }, - "DigitalSignature": { - "type": "boolean" - }, - "EncipherOnly": { - "type": "boolean" - }, - "KeyAgreement": { - "type": "boolean" - }, - "KeyCertSign": { - "type": "boolean" - }, - "KeyEncipherment": { - "type": "boolean" - }, - "NonRepudiation": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.OtherName": { - "additionalProperties": false, - "properties": { - "TypeId": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "TypeId", - "Value" - ], - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.RevocationConfiguration": { - "additionalProperties": false, - "properties": { - "CrlConfiguration": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.CrlConfiguration" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.Subject": { - "additionalProperties": false, - "properties": { - "CommonName": { - "type": "string" - }, - "Country": { - "type": "string" - }, - "DistinguishedNameQualifier": { - "type": "string" - }, - "GenerationQualifier": { - "type": "string" - }, - "GivenName": { - "type": "string" - }, - "Initials": { - "type": "string" - }, - "Locality": { - "type": "string" - }, - "Organization": { - "type": "string" - }, - "OrganizationalUnit": { - "type": "string" - }, - "Pseudonym": { - "type": "string" - }, - "SerialNumber": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Surname": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthority.SubjectInformationAccess": { - "additionalProperties": false, - "properties": { - "SubjectInformationAccess": { - "items": { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.AccessDescription" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ACMPCA::CertificateAuthorityActivation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "CertificateAuthorityArn": { - "type": "string" - }, - "CertificateChain": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Certificate", - "CertificateAuthorityArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ACMPCA::CertificateAuthorityActivation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AccessAnalyzer::Analyzer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AnalyzerName": { - "type": "string" - }, - "ArchiveRules": { - "items": { - "$ref": "#/definitions/AWS::AccessAnalyzer::Analyzer.ArchiveRule" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AccessAnalyzer::Analyzer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AccessAnalyzer::Analyzer.ArchiveRule": { - "additionalProperties": false, - "properties": { - "Filter": { - "items": { - "$ref": "#/definitions/AWS::AccessAnalyzer::Analyzer.Filter" - }, - "type": "array" - }, - "RuleName": { - "type": "string" - } - }, - "required": [ - "Filter", - "RuleName" - ], - "type": "object" - }, - "AWS::AccessAnalyzer::Analyzer.Filter": { - "additionalProperties": false, - "properties": { - "Contains": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Eq": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Exists": { - "type": "boolean" - }, - "Neq": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Property": { - "type": "string" - } - }, - "required": [ - "Property" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationStrategy": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "BrokerName": { - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.ConfigurationId" - }, - "DeploymentMode": { - "type": "string" - }, - "EncryptionOptions": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.EncryptionOptions" - }, - "EngineType": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "HostInstanceType": { - "type": "string" - }, - "LdapServerMetadata": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.LdapServerMetadata" - }, - "Logs": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.LogList" - }, - "MaintenanceWindowStartTime": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.MaintenanceWindow" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StorageType": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.TagsEntry" - }, - "type": "array" - }, - "Users": { - "items": { - "$ref": "#/definitions/AWS::AmazonMQ::Broker.User" - }, - "type": "array" - } - }, - "required": [ - "AutoMinorVersionUpgrade", - "BrokerName", - "DeploymentMode", - "EngineType", - "EngineVersion", - "HostInstanceType", - "PubliclyAccessible", - "Users" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AmazonMQ::Broker" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.ConfigurationId": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Revision": { - "type": "number" - } - }, - "required": [ - "Id", - "Revision" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.EncryptionOptions": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "UseAwsOwnedKey": { - "type": "boolean" - } - }, - "required": [ - "UseAwsOwnedKey" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.LdapServerMetadata": { - "additionalProperties": false, - "properties": { - "Hosts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RoleBase": { - "type": "string" - }, - "RoleName": { - "type": "string" - }, - "RoleSearchMatching": { - "type": "string" - }, - "RoleSearchSubtree": { - "type": "boolean" - }, - "ServiceAccountPassword": { - "type": "string" - }, - "ServiceAccountUsername": { - "type": "string" - }, - "UserBase": { - "type": "string" - }, - "UserRoleName": { - "type": "string" - }, - "UserSearchMatching": { - "type": "string" - }, - "UserSearchSubtree": { - "type": "boolean" - } - }, - "required": [ - "Hosts", - "RoleBase", - "RoleSearchMatching", - "ServiceAccountPassword", - "ServiceAccountUsername", - "UserBase", - "UserSearchMatching" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.LogList": { - "additionalProperties": false, - "properties": { - "Audit": { - "type": "boolean" - }, - "General": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::AmazonMQ::Broker.MaintenanceWindow": { - "additionalProperties": false, - "properties": { - "DayOfWeek": { - "type": "string" - }, - "TimeOfDay": { - "type": "string" - }, - "TimeZone": { - "type": "string" - } - }, - "required": [ - "DayOfWeek", - "TimeOfDay", - "TimeZone" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::AmazonMQ::Broker.User": { - "additionalProperties": false, - "properties": { - "ConsoleAccess": { - "type": "boolean" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::AmazonMQ::Configuration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationStrategy": { - "type": "string" - }, - "Data": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EngineType": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AmazonMQ::Configuration.TagsEntry" - }, - "type": "array" - } - }, - "required": [ - "Data", - "EngineType", - "EngineVersion", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AmazonMQ::Configuration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AmazonMQ::Configuration.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::AmazonMQ::ConfigurationAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Broker": { - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId" - } - }, - "required": [ - "Broker", - "Configuration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AmazonMQ::ConfigurationAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AmazonMQ::ConfigurationAssociation.ConfigurationId": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Revision": { - "type": "number" - } - }, - "required": [ - "Id", - "Revision" - ], - "type": "object" - }, - "AWS::Amplify::App": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "AutoBranchCreationConfig": { - "$ref": "#/definitions/AWS::Amplify::App.AutoBranchCreationConfig" - }, - "BasicAuthConfig": { - "$ref": "#/definitions/AWS::Amplify::App.BasicAuthConfig" - }, - "BuildSpec": { - "type": "string" - }, - "CustomHeaders": { - "type": "string" - }, - "CustomRules": { - "items": { - "$ref": "#/definitions/AWS::Amplify::App.CustomRule" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "EnableBranchAutoDeletion": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/AWS::Amplify::App.EnvironmentVariable" - }, - "type": "array" - }, - "IAMServiceRole": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OauthToken": { - "type": "string" - }, - "Repository": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Amplify::App" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Amplify::App.AutoBranchCreationConfig": { - "additionalProperties": false, - "properties": { - "AutoBranchCreationPatterns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BasicAuthConfig": { - "$ref": "#/definitions/AWS::Amplify::App.BasicAuthConfig" - }, - "BuildSpec": { - "type": "string" - }, - "EnableAutoBranchCreation": { - "type": "boolean" - }, - "EnableAutoBuild": { - "type": "boolean" - }, - "EnablePerformanceMode": { - "type": "boolean" - }, - "EnablePullRequestPreview": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/AWS::Amplify::App.EnvironmentVariable" - }, - "type": "array" - }, - "PullRequestEnvironmentName": { - "type": "string" - }, - "Stage": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Amplify::App.BasicAuthConfig": { - "additionalProperties": false, - "properties": { - "EnableBasicAuth": { - "type": "boolean" - }, - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Amplify::App.CustomRule": { - "additionalProperties": false, - "properties": { - "Condition": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Source", - "Target" - ], - "type": "object" - }, - "AWS::Amplify::App.EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::Amplify::Branch": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppId": { - "type": "string" - }, - "BasicAuthConfig": { - "$ref": "#/definitions/AWS::Amplify::Branch.BasicAuthConfig" - }, - "BranchName": { - "type": "string" - }, - "BuildSpec": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EnableAutoBuild": { - "type": "boolean" - }, - "EnablePerformanceMode": { - "type": "boolean" - }, - "EnablePullRequestPreview": { - "type": "boolean" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/AWS::Amplify::Branch.EnvironmentVariable" - }, - "type": "array" - }, - "PullRequestEnvironmentName": { - "type": "string" - }, - "Stage": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AppId", - "BranchName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Amplify::Branch" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Amplify::Branch.BasicAuthConfig": { - "additionalProperties": false, - "properties": { - "EnableBasicAuth": { - "type": "boolean" - }, - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::Amplify::Branch.EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::Amplify::Domain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppId": { - "type": "string" - }, - "AutoSubDomainCreationPatterns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AutoSubDomainIAMRole": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "EnableAutoSubDomain": { - "type": "boolean" - }, - "SubDomainSettings": { - "items": { - "$ref": "#/definitions/AWS::Amplify::Domain.SubDomainSetting" - }, - "type": "array" - } - }, - "required": [ - "AppId", - "DomainName", - "SubDomainSettings" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Amplify::Domain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Amplify::Domain.SubDomainSetting": { - "additionalProperties": false, - "properties": { - "BranchName": { - "type": "string" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "BranchName", - "Prefix" - ], - "type": "object" - }, - "AWS::ApiGateway::Account": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CloudWatchRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Account" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::ApiKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CustomerId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "GenerateDistinctId": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "StageKeys": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::ApiKey.StageKey" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::ApiKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::ApiKey.StageKey": { - "additionalProperties": false, - "properties": { - "RestApiId": { - "type": "string" - }, - "StageName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Authorizer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthType": { - "type": "string" - }, - "AuthorizerCredentials": { - "type": "string" - }, - "AuthorizerResultTtlInSeconds": { - "type": "number" - }, - "AuthorizerUri": { - "type": "string" - }, - "IdentitySource": { - "type": "string" - }, - "IdentityValidationExpression": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ProviderARNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RestApiId": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "RestApiId", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Authorizer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::BasePathMapping": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BasePath": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "RestApiId": { - "type": "string" - }, - "Stage": { - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::BasePathMapping" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::ClientCertificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::ClientCertificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::Deployment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeploymentCanarySettings": { - "$ref": "#/definitions/AWS::ApiGateway::Deployment.DeploymentCanarySettings" - }, - "Description": { - "type": "string" - }, - "RestApiId": { - "type": "string" - }, - "StageDescription": { - "$ref": "#/definitions/AWS::ApiGateway::Deployment.StageDescription" - }, - "StageName": { - "type": "string" - } - }, - "required": [ - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Deployment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::Deployment.AccessLogSetting": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Deployment.CanarySetting": { - "additionalProperties": false, - "properties": { - "PercentTraffic": { - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Deployment.DeploymentCanarySettings": { - "additionalProperties": false, - "properties": { - "PercentTraffic": { - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Deployment.MethodSetting": { - "additionalProperties": false, - "properties": { - "CacheDataEncrypted": { - "type": "boolean" - }, - "CacheTtlInSeconds": { - "type": "number" - }, - "CachingEnabled": { - "type": "boolean" - }, - "DataTraceEnabled": { - "type": "boolean" - }, - "HttpMethod": { - "type": "string" - }, - "LoggingLevel": { - "type": "string" - }, - "MetricsEnabled": { - "type": "boolean" - }, - "ResourcePath": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "number" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Deployment.StageDescription": { - "additionalProperties": false, - "properties": { - "AccessLogSetting": { - "$ref": "#/definitions/AWS::ApiGateway::Deployment.AccessLogSetting" - }, - "CacheClusterEnabled": { - "type": "boolean" - }, - "CacheClusterSize": { - "type": "string" - }, - "CacheDataEncrypted": { - "type": "boolean" - }, - "CacheTtlInSeconds": { - "type": "number" - }, - "CachingEnabled": { - "type": "boolean" - }, - "CanarySetting": { - "$ref": "#/definitions/AWS::ApiGateway::Deployment.CanarySetting" - }, - "ClientCertificateId": { - "type": "string" - }, - "DataTraceEnabled": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DocumentationVersion": { - "type": "string" - }, - "LoggingLevel": { - "type": "string" - }, - "MethodSettings": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::Deployment.MethodSetting" - }, - "type": "array" - }, - "MetricsEnabled": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThrottlingBurstLimit": { - "type": "number" - }, - "ThrottlingRateLimit": { - "type": "number" - }, - "TracingEnabled": { - "type": "boolean" - }, - "Variables": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::ApiGateway::DocumentationPart": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Location": { - "$ref": "#/definitions/AWS::ApiGateway::DocumentationPart.Location" - }, - "Properties": { - "type": "string" - }, - "RestApiId": { - "type": "string" - } - }, - "required": [ - "Location", - "Properties", - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::DocumentationPart" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::DocumentationPart.Location": { - "additionalProperties": false, - "properties": { - "Method": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "StatusCode": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::DocumentationVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DocumentationVersion": { - "type": "string" - }, - "RestApiId": { - "type": "string" - } - }, - "required": [ - "DocumentationVersion", - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::DocumentationVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::DomainName": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/AWS::ApiGateway::DomainName.EndpointConfiguration" - }, - "MutualTlsAuthentication": { - "$ref": "#/definitions/AWS::ApiGateway::DomainName.MutualTlsAuthentication" - }, - "RegionalCertificateArn": { - "type": "string" - }, - "SecurityPolicy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::DomainName" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::DomainName.EndpointConfiguration": { - "additionalProperties": false, - "properties": { - "Types": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApiGateway::DomainName.MutualTlsAuthentication": { - "additionalProperties": false, - "properties": { - "TruststoreUri": { - "type": "string" - }, - "TruststoreVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::GatewayResponse": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResponseParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseTemplates": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseType": { - "type": "string" - }, - "RestApiId": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "ResponseType", - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::GatewayResponse" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::Method": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiKeyRequired": { - "type": "boolean" - }, - "AuthorizationScopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AuthorizationType": { - "type": "string" - }, - "AuthorizerId": { - "type": "string" - }, - "HttpMethod": { - "type": "string" - }, - "Integration": { - "$ref": "#/definitions/AWS::ApiGateway::Method.Integration" - }, - "MethodResponses": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::Method.MethodResponse" - }, - "type": "array" - }, - "OperationName": { - "type": "string" - }, - "RequestModels": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "RequestParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "boolean" - } - }, - "type": "object" - }, - "RequestValidatorId": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "RestApiId": { - "type": "string" - } - }, - "required": [ - "HttpMethod", - "ResourceId", - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Method" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::Method.Integration": { - "additionalProperties": false, - "properties": { - "CacheKeyParameters": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CacheNamespace": { - "type": "string" - }, - "ConnectionId": { - "type": "string" - }, - "ConnectionType": { - "type": "string" - }, - "ContentHandling": { - "type": "string" - }, - "Credentials": { - "type": "string" - }, - "IntegrationHttpMethod": { - "type": "string" - }, - "IntegrationResponses": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::Method.IntegrationResponse" - }, - "type": "array" - }, - "PassthroughBehavior": { - "type": "string" - }, - "RequestParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "RequestTemplates": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "TimeoutInMillis": { - "type": "number" - }, - "Type": { - "type": "string" - }, - "Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Method.IntegrationResponse": { - "additionalProperties": false, - "properties": { - "ContentHandling": { - "type": "string" - }, - "ResponseParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseTemplates": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "SelectionPattern": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ApiGateway::Method.MethodResponse": { - "additionalProperties": false, - "properties": { - "ResponseModels": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ResponseParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "boolean" - } - }, - "type": "object" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ApiGateway::Model": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContentType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RestApiId": { - "type": "string" - }, - "Schema": { - "type": "object" - } - }, - "required": [ - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Model" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::RequestValidator": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RestApiId": { - "type": "string" - }, - "ValidateRequestBody": { - "type": "boolean" - }, - "ValidateRequestParameters": { - "type": "boolean" - } - }, - "required": [ - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::RequestValidator" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::Resource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ParentId": { - "type": "string" - }, - "PathPart": { - "type": "string" - }, - "RestApiId": { - "type": "string" - } - }, - "required": [ - "ParentId", - "PathPart", - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Resource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::RestApi": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiKeySourceType": { - "type": "string" - }, - "BinaryMediaTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Body": { - "type": "object" - }, - "BodyS3Location": { - "$ref": "#/definitions/AWS::ApiGateway::RestApi.S3Location" - }, - "CloneFrom": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/AWS::ApiGateway::RestApi.EndpointConfiguration" - }, - "FailOnWarnings": { - "type": "boolean" - }, - "MinimumCompressionSize": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Policy": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::RestApi" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::RestApi.EndpointConfiguration": { - "additionalProperties": false, - "properties": { - "Types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcEndpointIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApiGateway::RestApi.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "ETag": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Stage": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessLogSetting": { - "$ref": "#/definitions/AWS::ApiGateway::Stage.AccessLogSetting" - }, - "CacheClusterEnabled": { - "type": "boolean" - }, - "CacheClusterSize": { - "type": "string" - }, - "CanarySetting": { - "$ref": "#/definitions/AWS::ApiGateway::Stage.CanarySetting" - }, - "ClientCertificateId": { - "type": "string" - }, - "DeploymentId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DocumentationVersion": { - "type": "string" - }, - "MethodSettings": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::Stage.MethodSetting" - }, - "type": "array" - }, - "RestApiId": { - "type": "string" - }, - "StageName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TracingEnabled": { - "type": "boolean" - }, - "Variables": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "RestApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::Stage" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::Stage.AccessLogSetting": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Stage.CanarySetting": { - "additionalProperties": false, - "properties": { - "DeploymentId": { - "type": "string" - }, - "PercentTraffic": { - "type": "number" - }, - "StageVariableOverrides": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "UseStageCache": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ApiGateway::Stage.MethodSetting": { - "additionalProperties": false, - "properties": { - "CacheDataEncrypted": { - "type": "boolean" - }, - "CacheTtlInSeconds": { - "type": "number" - }, - "CachingEnabled": { - "type": "boolean" - }, - "DataTraceEnabled": { - "type": "boolean" - }, - "HttpMethod": { - "type": "string" - }, - "LoggingLevel": { - "type": "string" - }, - "MetricsEnabled": { - "type": "boolean" - }, - "ResourcePath": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "number" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGateway::UsagePlan": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiStages": { - "items": { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ApiStage" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Quota": { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.QuotaSettings" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Throttle": { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings" - }, - "UsagePlanName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::UsagePlan" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGateway::UsagePlan.ApiStage": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "Stage": { - "type": "string" - }, - "Throttle": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::ApiGateway::UsagePlan.QuotaSettings": { - "additionalProperties": false, - "properties": { - "Limit": { - "type": "number" - }, - "Offset": { - "type": "number" - }, - "Period": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGateway::UsagePlan.ThrottleSettings": { - "additionalProperties": false, - "properties": { - "BurstLimit": { - "type": "number" - }, - "RateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGateway::UsagePlanKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "KeyId": { - "type": "string" - }, - "KeyType": { - "type": "string" - }, - "UsagePlanId": { - "type": "string" - } - }, - "required": [ - "KeyId", - "KeyType", - "UsagePlanId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::UsagePlanKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGateway::VpcLink": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "TargetArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "TargetArns" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGateway::VpcLink" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Api": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiKeySelectionExpression": { - "type": "string" - }, - "BasePath": { - "type": "string" - }, - "Body": { - "type": "object" - }, - "BodyS3Location": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Api.BodyS3Location" - }, - "CorsConfiguration": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Api.Cors" - }, - "CredentialsArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisableExecuteApiEndpoint": { - "type": "boolean" - }, - "DisableSchemaValidation": { - "type": "boolean" - }, - "FailOnWarnings": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "ProtocolType": { - "type": "string" - }, - "RouteKey": { - "type": "string" - }, - "RouteSelectionExpression": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Target": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Api" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Api.BodyS3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Etag": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::Api.Cors": { - "additionalProperties": false, - "properties": { - "AllowCredentials": { - "type": "boolean" - }, - "AllowHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ExposeHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxAge": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "Integration": { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides.IntegrationOverrides" - }, - "Route": { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteOverrides" - }, - "Stage": { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides.StageOverrides" - } - }, - "required": [ - "ApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.AccessLogSettings": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.IntegrationOverrides": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "IntegrationMethod": { - "type": "string" - }, - "PayloadFormatVersion": { - "type": "string" - }, - "TimeoutInMillis": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteOverrides": { - "additionalProperties": false, - "properties": { - "AuthorizationScopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AuthorizationType": { - "type": "string" - }, - "AuthorizerId": { - "type": "string" - }, - "OperationName": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteSettings": { - "additionalProperties": false, - "properties": { - "DataTraceEnabled": { - "type": "boolean" - }, - "DetailedMetricsEnabled": { - "type": "boolean" - }, - "LoggingLevel": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "number" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiGatewayManagedOverrides.StageOverrides": { - "additionalProperties": false, - "properties": { - "AccessLogSettings": { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides.AccessLogSettings" - }, - "AutoDeploy": { - "type": "boolean" - }, - "DefaultRouteSettings": { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides.RouteSettings" - }, - "Description": { - "type": "string" - }, - "RouteSettings": { - "type": "object" - }, - "StageVariables": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::ApiMapping": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ApiMappingKey": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "Stage": { - "type": "string" - } - }, - "required": [ - "ApiId", - "DomainName", - "Stage" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::ApiMapping" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Authorizer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "AuthorizerCredentialsArn": { - "type": "string" - }, - "AuthorizerPayloadFormatVersion": { - "type": "string" - }, - "AuthorizerResultTtlInSeconds": { - "type": "number" - }, - "AuthorizerType": { - "type": "string" - }, - "AuthorizerUri": { - "type": "string" - }, - "EnableSimpleResponses": { - "type": "boolean" - }, - "IdentitySource": { - "items": { - "type": "string" - }, - "type": "array" - }, - "IdentityValidationExpression": { - "type": "string" - }, - "JwtConfiguration": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Authorizer.JWTConfiguration" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ApiId", - "AuthorizerType", - "IdentitySource", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Authorizer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Authorizer.JWTConfiguration": { - "additionalProperties": false, - "properties": { - "Audience": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Issuer": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::Deployment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "StageName": { - "type": "string" - } - }, - "required": [ - "ApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Deployment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::DomainName": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "DomainNameConfigurations": { - "items": { - "$ref": "#/definitions/AWS::ApiGatewayV2::DomainName.DomainNameConfiguration" - }, - "type": "array" - }, - "MutualTlsAuthentication": { - "$ref": "#/definitions/AWS::ApiGatewayV2::DomainName.MutualTlsAuthentication" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::DomainName" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::DomainName.DomainNameConfiguration": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "CertificateName": { - "type": "string" - }, - "EndpointType": { - "type": "string" - }, - "SecurityPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::DomainName.MutualTlsAuthentication": { - "additionalProperties": false, - "properties": { - "TruststoreUri": { - "type": "string" - }, - "TruststoreVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::Integration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ConnectionId": { - "type": "string" - }, - "ConnectionType": { - "type": "string" - }, - "ContentHandlingStrategy": { - "type": "string" - }, - "CredentialsArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "IntegrationMethod": { - "type": "string" - }, - "IntegrationSubtype": { - "type": "string" - }, - "IntegrationType": { - "type": "string" - }, - "IntegrationUri": { - "type": "string" - }, - "PassthroughBehavior": { - "type": "string" - }, - "PayloadFormatVersion": { - "type": "string" - }, - "RequestParameters": { - "type": "object" - }, - "RequestTemplates": { - "type": "object" - }, - "ResponseParameters": { - "type": "object" - }, - "TemplateSelectionExpression": { - "type": "string" - }, - "TimeoutInMillis": { - "type": "number" - }, - "TlsConfig": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Integration.TlsConfig" - } - }, - "required": [ - "ApiId", - "IntegrationType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Integration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Integration.ResponseParameter": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - }, - "Source": { - "type": "string" - } - }, - "required": [ - "Destination", - "Source" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Integration.ResponseParameterList": { - "additionalProperties": false, - "properties": { - "ResponseParameters": { - "items": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Integration.ResponseParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::Integration.TlsConfig": { - "additionalProperties": false, - "properties": { - "ServerNameToVerify": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::IntegrationResponse": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ContentHandlingStrategy": { - "type": "string" - }, - "IntegrationId": { - "type": "string" - }, - "IntegrationResponseKey": { - "type": "string" - }, - "ResponseParameters": { - "type": "object" - }, - "ResponseTemplates": { - "type": "object" - }, - "TemplateSelectionExpression": { - "type": "string" - } - }, - "required": [ - "ApiId", - "IntegrationId", - "IntegrationResponseKey" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::IntegrationResponse" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Model": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ContentType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Schema": { - "type": "object" - } - }, - "required": [ - "ApiId", - "Name", - "Schema" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Model" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Route": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ApiKeyRequired": { - "type": "boolean" - }, - "AuthorizationScopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AuthorizationType": { - "type": "string" - }, - "AuthorizerId": { - "type": "string" - }, - "ModelSelectionExpression": { - "type": "string" - }, - "OperationName": { - "type": "string" - }, - "RequestModels": { - "type": "object" - }, - "RequestParameters": { - "type": "object" - }, - "RouteKey": { - "type": "string" - }, - "RouteResponseSelectionExpression": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "ApiId", - "RouteKey" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Route" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Route.ParameterConstraints": { - "additionalProperties": false, - "properties": { - "Required": { - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::RouteResponse": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ModelSelectionExpression": { - "type": "string" - }, - "ResponseModels": { - "type": "object" - }, - "ResponseParameters": { - "type": "object" - }, - "RouteId": { - "type": "string" - }, - "RouteResponseKey": { - "type": "string" - } - }, - "required": [ - "ApiId", - "RouteId", - "RouteResponseKey" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::RouteResponse" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::RouteResponse.ParameterConstraints": { - "additionalProperties": false, - "properties": { - "Required": { - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Stage": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessLogSettings": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Stage.AccessLogSettings" - }, - "AccessPolicyId": { - "type": "string" - }, - "ApiId": { - "type": "string" - }, - "AutoDeploy": { - "type": "boolean" - }, - "ClientCertificateId": { - "type": "string" - }, - "DefaultRouteSettings": { - "$ref": "#/definitions/AWS::ApiGatewayV2::Stage.RouteSettings" - }, - "DeploymentId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "RouteSettings": { - "type": "object" - }, - "StageName": { - "type": "string" - }, - "StageVariables": { - "type": "object" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "ApiId", - "StageName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::Stage" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApiGatewayV2::Stage.AccessLogSettings": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Format": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::Stage.RouteSettings": { - "additionalProperties": false, - "properties": { - "DataTraceEnabled": { - "type": "boolean" - }, - "DetailedMetricsEnabled": { - "type": "boolean" - }, - "LoggingLevel": { - "type": "string" - }, - "ThrottlingBurstLimit": { - "type": "number" - }, - "ThrottlingRateLimit": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApiGatewayV2::VpcLink": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApiGatewayV2::VpcLink" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::Application.Tags" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::Application.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::ConfigurationProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "LocationUri": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RetrievalRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::ConfigurationProfile.Tags" - }, - "type": "array" - }, - "Validators": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::ConfigurationProfile.Validators" - }, - "type": "array" - } - }, - "required": [ - "ApplicationId", - "LocationUri", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::ConfigurationProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::ConfigurationProfile.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::ConfigurationProfile.Validators": { - "additionalProperties": false, - "properties": { - "Content": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::Deployment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "ConfigurationProfileId": { - "type": "string" - }, - "ConfigurationVersion": { - "type": "string" - }, - "DeploymentStrategyId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EnvironmentId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::Deployment.Tags" - }, - "type": "array" - } - }, - "required": [ - "ApplicationId", - "ConfigurationProfileId", - "ConfigurationVersion", - "DeploymentStrategyId", - "EnvironmentId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::Deployment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::Deployment.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::DeploymentStrategy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeploymentDurationInMinutes": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "FinalBakeTimeInMinutes": { - "type": "number" - }, - "GrowthFactor": { - "type": "number" - }, - "GrowthType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReplicateTo": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::DeploymentStrategy.Tags" - }, - "type": "array" - } - }, - "required": [ - "DeploymentDurationInMinutes", - "GrowthFactor", - "Name", - "ReplicateTo" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::DeploymentStrategy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::DeploymentStrategy.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::Environment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Monitors": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::Environment.Monitors" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AppConfig::Environment.Tags" - }, - "type": "array" - } - }, - "required": [ - "ApplicationId", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::Environment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppConfig::Environment.Monitors": { - "additionalProperties": false, - "properties": { - "AlarmArn": { - "type": "string" - }, - "AlarmRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::Environment.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppConfig::HostedConfigurationVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "ConfigurationProfileId": { - "type": "string" - }, - "Content": { - "type": "string" - }, - "ContentType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "LatestVersionNumber": { - "type": "number" - } - }, - "required": [ - "ApplicationId", - "ConfigurationProfileId", - "Content", - "ContentType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppConfig::HostedConfigurationVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionMode": { - "type": "string" - }, - "ConnectorProfileConfig": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig" - }, - "ConnectorProfileName": { - "type": "string" - }, - "ConnectorType": { - "type": "string" - }, - "KMSArn": { - "type": "string" - } - }, - "required": [ - "ConnectionMode", - "ConnectorProfileName", - "ConnectorType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppFlow::ConnectorProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.AmplitudeConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "type": "string" - }, - "SecretKey": { - "type": "string" - } - }, - "required": [ - "ApiKey", - "SecretKey" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest": { - "additionalProperties": false, - "properties": { - "AuthCode": { - "type": "string" - }, - "RedirectUri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ConnectorProfileConfig": { - "additionalProperties": false, - "properties": { - "ConnectorProfileCredentials": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials" - }, - "ConnectorProfileProperties": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorProfileProperties" - } - }, - "required": [ - "ConnectorProfileCredentials" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "Amplitude": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.AmplitudeConnectorProfileCredentials" - }, - "Datadog": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials" - }, - "Dynatrace": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileCredentials" - }, - "GoogleAnalytics": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.GoogleAnalyticsConnectorProfileCredentials" - }, - "InforNexus": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileCredentials" - }, - "Marketo": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileCredentials" - }, - "Redshift": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials" - }, - "Salesforce": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileCredentials" - }, - "ServiceNow": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileCredentials" - }, - "Singular": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SingularConnectorProfileCredentials" - }, - "Slack": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SlackConnectorProfileCredentials" - }, - "Snowflake": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileCredentials" - }, - "Trendmicro": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.TrendmicroConnectorProfileCredentials" - }, - "Veeva": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileCredentials" - }, - "Zendesk": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileCredentials" - } - }, - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "Datadog": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties" - }, - "Dynatrace": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileProperties" - }, - "InforNexus": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileProperties" - }, - "Marketo": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileProperties" - }, - "Redshift": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties" - }, - "Salesforce": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileProperties" - }, - "ServiceNow": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileProperties" - }, - "Slack": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SlackConnectorProfileProperties" - }, - "Snowflake": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileProperties" - }, - "Veeva": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileProperties" - }, - "Zendesk": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileProperties" - } - }, - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "type": "string" - }, - "ApplicationKey": { - "type": "string" - } - }, - "required": [ - "ApiKey", - "ApplicationKey" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiToken": { - "type": "string" - } - }, - "required": [ - "ApiToken" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.DynatraceConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.GoogleAnalyticsConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" - }, - "RefreshToken": { - "type": "string" - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessKeyId": { - "type": "string" - }, - "Datakey": { - "type": "string" - }, - "SecretAccessKey": { - "type": "string" - }, - "UserId": { - "type": "string" - } - }, - "required": [ - "AccessKeyId", - "Datakey", - "SecretAccessKey", - "UserId" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.InforNexusConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.MarketoConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "DatabaseUrl": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "BucketName", - "DatabaseUrl", - "RoleArn" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "ClientCredentialsArn": { - "type": "string" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" - }, - "RefreshToken": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SalesforceConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - }, - "isSandboxEnvironment": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ServiceNowConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SingularConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "type": "string" - } - }, - "required": [ - "ApiKey" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SlackConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SlackConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.SnowflakeConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "AccountName": { - "type": "string" - }, - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "PrivateLinkServiceName": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "Stage": { - "type": "string" - }, - "Warehouse": { - "type": "string" - } - }, - "required": [ - "BucketName", - "Stage", - "Warehouse" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.TrendmicroConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "ApiSecretKey": { - "type": "string" - } - }, - "required": [ - "ApiSecretKey" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "Password", - "Username" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.VeevaConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileCredentials": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" - } - }, - "required": [ - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "AWS::AppFlow::ConnectorProfile.ZendeskConnectorProfileProperties": { - "additionalProperties": false, - "properties": { - "InstanceUrl": { - "type": "string" - } - }, - "required": [ - "InstanceUrl" - ], - "type": "object" - }, - "AWS::AppFlow::Flow": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DestinationFlowConfigList": { - "items": { - "$ref": "#/definitions/AWS::AppFlow::Flow.DestinationFlowConfig" - }, - "type": "array" - }, - "FlowName": { - "type": "string" - }, - "KMSArn": { - "type": "string" - }, - "SourceFlowConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SourceFlowConfig" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Tasks": { - "items": { - "$ref": "#/definitions/AWS::AppFlow::Flow.Task" - }, - "type": "array" - }, - "TriggerConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.TriggerConfig" - } - }, - "required": [ - "DestinationFlowConfigList", - "FlowName", - "SourceFlowConfig", - "Tasks", - "TriggerConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppFlow::Flow" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.AggregationConfig": { - "additionalProperties": false, - "properties": { - "AggregationType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.AmplitudeSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.ConnectorOperator": { - "additionalProperties": false, - "properties": { - "Amplitude": { - "type": "string" - }, - "Datadog": { - "type": "string" - }, - "Dynatrace": { - "type": "string" - }, - "GoogleAnalytics": { - "type": "string" - }, - "InforNexus": { - "type": "string" - }, - "Marketo": { - "type": "string" - }, - "S3": { - "type": "string" - }, - "Salesforce": { - "type": "string" - }, - "ServiceNow": { - "type": "string" - }, - "Singular": { - "type": "string" - }, - "Slack": { - "type": "string" - }, - "Trendmicro": { - "type": "string" - }, - "Veeva": { - "type": "string" - }, - "Zendesk": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.DatadogSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.DestinationConnectorProperties": { - "additionalProperties": false, - "properties": { - "EventBridge": { - "$ref": "#/definitions/AWS::AppFlow::Flow.EventBridgeDestinationProperties" - }, - "Redshift": { - "$ref": "#/definitions/AWS::AppFlow::Flow.RedshiftDestinationProperties" - }, - "S3": { - "$ref": "#/definitions/AWS::AppFlow::Flow.S3DestinationProperties" - }, - "Salesforce": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SalesforceDestinationProperties" - }, - "Snowflake": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SnowflakeDestinationProperties" - }, - "Upsolver": { - "$ref": "#/definitions/AWS::AppFlow::Flow.UpsolverDestinationProperties" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.DestinationFlowConfig": { - "additionalProperties": false, - "properties": { - "ConnectorProfileName": { - "type": "string" - }, - "ConnectorType": { - "type": "string" - }, - "DestinationConnectorProperties": { - "$ref": "#/definitions/AWS::AppFlow::Flow.DestinationConnectorProperties" - } - }, - "required": [ - "ConnectorType", - "DestinationConnectorProperties" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.DynatraceSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.ErrorHandlingConfig": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "FailOnFirstError": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.EventBridgeDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" - }, - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.GoogleAnalyticsSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.IdFieldNamesList": { - "additionalProperties": false, - "properties": { - "IdFieldNamesList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.IncrementalPullConfig": { - "additionalProperties": false, - "properties": { - "DatetimeTypeFieldName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.InforNexusSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.MarketoSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.PrefixConfig": { - "additionalProperties": false, - "properties": { - "PrefixFormat": { - "type": "string" - }, - "PrefixType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.RedshiftDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketPrefix": { - "type": "string" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" - }, - "IntermediateBucketName": { - "type": "string" - }, - "Object": { - "type": "string" - } - }, - "required": [ - "IntermediateBucketName", - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.S3DestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "S3OutputFormatConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.S3OutputFormatConfig" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.S3OutputFormatConfig": { - "additionalProperties": false, - "properties": { - "AggregationConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.AggregationConfig" - }, - "FileType": { - "type": "string" - }, - "PrefixConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.PrefixConfig" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.S3SourceProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - } - }, - "required": [ - "BucketName", - "BucketPrefix" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SalesforceDestinationProperties": { - "additionalProperties": false, - "properties": { - "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" - }, - "IdFieldNames": { - "$ref": "#/definitions/AWS::AppFlow::Flow.IdFieldNamesList" - }, - "Object": { - "type": "string" - }, - "WriteOperationType": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SalesforceSourceProperties": { - "additionalProperties": false, - "properties": { - "EnableDynamicFieldUpdate": { - "type": "boolean" - }, - "IncludeDeletedRecords": { - "type": "boolean" - }, - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.ScheduledTriggerProperties": { - "additionalProperties": false, - "properties": { - "DataPullMode": { - "type": "string" - }, - "ScheduleEndTime": { - "type": "number" - }, - "ScheduleExpression": { - "type": "string" - }, - "ScheduleStartTime": { - "type": "number" - }, - "TimeZone": { - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.ServiceNowSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SingularSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SlackSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SnowflakeDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketPrefix": { - "type": "string" - }, - "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" - }, - "IntermediateBucketName": { - "type": "string" - }, - "Object": { - "type": "string" - } - }, - "required": [ - "IntermediateBucketName", - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.SourceConnectorProperties": { - "additionalProperties": false, - "properties": { - "Amplitude": { - "$ref": "#/definitions/AWS::AppFlow::Flow.AmplitudeSourceProperties" - }, - "Datadog": { - "$ref": "#/definitions/AWS::AppFlow::Flow.DatadogSourceProperties" - }, - "Dynatrace": { - "$ref": "#/definitions/AWS::AppFlow::Flow.DynatraceSourceProperties" - }, - "GoogleAnalytics": { - "$ref": "#/definitions/AWS::AppFlow::Flow.GoogleAnalyticsSourceProperties" - }, - "InforNexus": { - "$ref": "#/definitions/AWS::AppFlow::Flow.InforNexusSourceProperties" - }, - "Marketo": { - "$ref": "#/definitions/AWS::AppFlow::Flow.MarketoSourceProperties" - }, - "S3": { - "$ref": "#/definitions/AWS::AppFlow::Flow.S3SourceProperties" - }, - "Salesforce": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SalesforceSourceProperties" - }, - "ServiceNow": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ServiceNowSourceProperties" - }, - "Singular": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SingularSourceProperties" - }, - "Slack": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SlackSourceProperties" - }, - "Trendmicro": { - "$ref": "#/definitions/AWS::AppFlow::Flow.TrendmicroSourceProperties" - }, - "Veeva": { - "$ref": "#/definitions/AWS::AppFlow::Flow.VeevaSourceProperties" - }, - "Zendesk": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ZendeskSourceProperties" - } - }, - "type": "object" - }, - "AWS::AppFlow::Flow.SourceFlowConfig": { - "additionalProperties": false, - "properties": { - "ConnectorProfileName": { - "type": "string" - }, - "ConnectorType": { - "type": "string" - }, - "IncrementalPullConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.IncrementalPullConfig" - }, - "SourceConnectorProperties": { - "$ref": "#/definitions/AWS::AppFlow::Flow.SourceConnectorProperties" - } - }, - "required": [ - "ConnectorType", - "SourceConnectorProperties" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.Task": { - "additionalProperties": false, - "properties": { - "ConnectorOperator": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ConnectorOperator" - }, - "DestinationField": { - "type": "string" - }, - "SourceFields": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TaskProperties": { - "items": { - "$ref": "#/definitions/AWS::AppFlow::Flow.TaskPropertiesObject" - }, - "type": "array" - }, - "TaskType": { - "type": "string" - } - }, - "required": [ - "SourceFields", - "TaskType" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.TaskPropertiesObject": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.TrendmicroSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.TriggerConfig": { - "additionalProperties": false, - "properties": { - "TriggerProperties": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ScheduledTriggerProperties" - }, - "TriggerType": { - "type": "string" - } - }, - "required": [ - "TriggerType" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.UpsolverDestinationProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "S3OutputFormatConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.UpsolverS3OutputFormatConfig" - } - }, - "required": [ - "BucketName", - "S3OutputFormatConfig" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.UpsolverS3OutputFormatConfig": { - "additionalProperties": false, - "properties": { - "AggregationConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.AggregationConfig" - }, - "FileType": { - "type": "string" - }, - "PrefixConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.PrefixConfig" - } - }, - "required": [ - "PrefixConfig" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.VeevaSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppFlow::Flow.ZendeskSourceProperties": { - "additionalProperties": false, - "properties": { - "Object": { - "type": "string" - } - }, - "required": [ - "Object" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GatewayRouteName": { - "type": "string" - }, - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GatewayRouteSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualGatewayName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec", - "VirtualGatewayName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::GatewayRoute" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GatewayRouteSpec": { - "additionalProperties": false, - "properties": { - "GrpcRoute": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GrpcGatewayRoute" - }, - "Http2Route": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.HttpGatewayRoute" - }, - "HttpRoute": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.HttpGatewayRoute" - } - }, - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GatewayRouteTarget": { - "additionalProperties": false, - "properties": { - "VirtualService": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GatewayRouteVirtualService" - } - }, - "required": [ - "VirtualService" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GatewayRouteVirtualService": { - "additionalProperties": false, - "properties": { - "VirtualServiceName": { - "type": "string" - } - }, - "required": [ - "VirtualServiceName" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GrpcGatewayRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GrpcGatewayRouteAction" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMatch" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteAction": { - "additionalProperties": false, - "properties": { - "Target": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GatewayRouteTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.GrpcGatewayRouteMatch": { - "additionalProperties": false, - "properties": { - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.HttpGatewayRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.HttpGatewayRouteAction" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.HttpGatewayRouteMatch" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.HttpGatewayRouteAction": { - "additionalProperties": false, - "properties": { - "Target": { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute.GatewayRouteTarget" - } - }, - "required": [ - "Target" - ], - "type": "object" - }, - "AWS::AppMesh::GatewayRoute.HttpGatewayRouteMatch": { - "additionalProperties": false, - "properties": { - "Prefix": { - "type": "string" - } - }, - "required": [ - "Prefix" - ], - "type": "object" - }, - "AWS::AppMesh::Mesh": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::Mesh.MeshSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::Mesh" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::AppMesh::Mesh.EgressFilter": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::AppMesh::Mesh.MeshSpec": { - "additionalProperties": false, - "properties": { - "EgressFilter": { - "$ref": "#/definitions/AWS::AppMesh::Mesh.EgressFilter" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "RouteName": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::Route.RouteSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualRouterName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec", - "VirtualRouterName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::Route" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::Route.Duration": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Unit", - "Value" - ], - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRetryPolicy": { - "additionalProperties": false, - "properties": { - "GrpcRetryEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "HttpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxRetries": { - "type": "number" - }, - "PerRetryTimeout": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - }, - "TcpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "MaxRetries", - "PerRetryTimeout" - ], - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRouteAction" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRouteMatch" - }, - "RetryPolicy": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRetryPolicy" - }, - "Timeout": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcTimeout" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::Route.WeightedTarget" - }, - "type": "array" - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRouteMatch": { - "additionalProperties": false, - "properties": { - "Metadata": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRouteMetadata" - }, - "type": "array" - }, - "MethodName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRouteMetadata": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::AppMesh::Route.GrpcRouteMetadataMatchMethod": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/AWS::AppMesh::Route.MatchRange" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.GrpcTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - }, - "PerRequest": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.HeaderMatchMethod": { - "additionalProperties": false, - "properties": { - "Exact": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Range": { - "$ref": "#/definitions/AWS::AppMesh::Route.MatchRange" - }, - "Regex": { - "type": "string" - }, - "Suffix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.HttpRetryPolicy": { - "additionalProperties": false, - "properties": { - "HttpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxRetries": { - "type": "number" - }, - "PerRetryTimeout": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - }, - "TcpRetryEvents": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "MaxRetries", - "PerRetryTimeout" - ], - "type": "object" - }, - "AWS::AppMesh::Route.HttpRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRouteAction" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRouteMatch" - }, - "RetryPolicy": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRetryPolicy" - }, - "Timeout": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpTimeout" - } - }, - "required": [ - "Action", - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::Route.HttpRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::Route.WeightedTarget" - }, - "type": "array" - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "AWS::AppMesh::Route.HttpRouteHeader": { - "additionalProperties": false, - "properties": { - "Invert": { - "type": "boolean" - }, - "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.HeaderMatchMethod" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::AppMesh::Route.HttpRouteMatch": { - "additionalProperties": false, - "properties": { - "Headers": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRouteHeader" - }, - "type": "array" - }, - "Method": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Scheme": { - "type": "string" - } - }, - "required": [ - "Prefix" - ], - "type": "object" - }, - "AWS::AppMesh::Route.HttpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - }, - "PerRequest": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.MatchRange": { - "additionalProperties": false, - "properties": { - "End": { - "type": "number" - }, - "Start": { - "type": "number" - } - }, - "required": [ - "End", - "Start" - ], - "type": "object" - }, - "AWS::AppMesh::Route.RouteSpec": { - "additionalProperties": false, - "properties": { - "GrpcRoute": { - "$ref": "#/definitions/AWS::AppMesh::Route.GrpcRoute" - }, - "Http2Route": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRoute" - }, - "HttpRoute": { - "$ref": "#/definitions/AWS::AppMesh::Route.HttpRoute" - }, - "Priority": { - "type": "number" - }, - "TcpRoute": { - "$ref": "#/definitions/AWS::AppMesh::Route.TcpRoute" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.TcpRoute": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::AppMesh::Route.TcpRouteAction" - }, - "Timeout": { - "$ref": "#/definitions/AWS::AppMesh::Route.TcpTimeout" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "AWS::AppMesh::Route.TcpRouteAction": { - "additionalProperties": false, - "properties": { - "WeightedTargets": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::Route.WeightedTarget" - }, - "type": "array" - } - }, - "required": [ - "WeightedTargets" - ], - "type": "object" - }, - "AWS::AppMesh::Route.TcpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::Route.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::Route.WeightedTarget": { - "additionalProperties": false, - "properties": { - "VirtualNode": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "required": [ - "VirtualNode", - "Weight" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewaySpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualGatewayName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::VirtualGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.SubjectAlternativeNameMatchers": { - "additionalProperties": false, - "properties": { - "Exact": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.SubjectAlternativeNames": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.SubjectAlternativeNameMatchers" - } - }, - "required": [ - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayAccessLog": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayFileAccessLog" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayBackendDefaults": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicy" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicy": { - "additionalProperties": false, - "properties": { - "TLS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicyTls" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayClientPolicyTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayClientTlsCertificate" - }, - "Enforce": { - "type": "boolean" - }, - "Ports": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Validation": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContext" - } - }, - "required": [ - "Validation" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayClientTlsCertificate": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayConnectionPool": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayGrpcConnectionPool" - }, - "HTTP": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayHttpConnectionPool" - }, - "HTTP2": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayHttp2ConnectionPool" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayFileAccessLog": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayGrpcConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "number" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayHealthCheckPolicy": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "number" - }, - "IntervalMillis": { - "type": "number" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "TimeoutMillis": { - "type": "number" - }, - "UnhealthyThreshold": { - "type": "number" - } - }, - "required": [ - "HealthyThreshold", - "IntervalMillis", - "Protocol", - "TimeoutMillis", - "UnhealthyThreshold" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayHttp2ConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "number" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayHttpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "number" - }, - "MaxPendingRequests": { - "type": "number" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListener": { - "additionalProperties": false, - "properties": { - "ConnectionPool": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayConnectionPool" - }, - "HealthCheck": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayHealthCheckPolicy" - }, - "PortMapping": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayPortMapping" - }, - "TLS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTls" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsCertificate" - }, - "Mode": { - "type": "string" - }, - "Validation": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContext" - } - }, - "required": [ - "Certificate", - "Mode" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsAcmCertificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsCertificate": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsAcmCertificate" - }, - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsFileCertificate": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "required": [ - "CertificateChain", - "PrivateKey" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsSdsCertificate": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayListenerTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayLogging": { - "additionalProperties": false, - "properties": { - "AccessLog": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayAccessLog" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayPortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewaySpec": { - "additionalProperties": false, - "properties": { - "BackendDefaults": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayBackendDefaults" - }, - "Listeners": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListener" - }, - "type": "array" - }, - "Logging": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayLogging" - } - }, - "required": [ - "Listeners" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextAcmTrust": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "CertificateAuthorityArns" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextFileTrust": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - } - }, - "required": [ - "CertificateChain" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextSdsTrust": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextAcmTrust" - }, - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayTlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualNodeName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::VirtualNode" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.AccessLog": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.FileAccessLog" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.AwsCloudMapInstanceAttribute" - }, - "type": "array" - }, - "NamespaceName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - } - }, - "required": [ - "NamespaceName", - "ServiceName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.Backend": { - "additionalProperties": false, - "properties": { - "VirtualService": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualServiceBackend" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.BackendDefaults": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ClientPolicy" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ClientPolicy": { - "additionalProperties": false, - "properties": { - "TLS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ClientPolicyTls" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ClientPolicyTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ClientTlsCertificate" - }, - "Enforce": { - "type": "boolean" - }, - "Ports": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Validation": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContext" - } - }, - "required": [ - "Validation" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ClientTlsCertificate": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.DnsServiceDiscovery": { - "additionalProperties": false, - "properties": { - "Hostname": { - "type": "string" - } - }, - "required": [ - "Hostname" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.Duration": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Unit", - "Value" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.FileAccessLog": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.GrpcTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - }, - "PerRequest": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.HealthCheck": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "number" - }, - "IntervalMillis": { - "type": "number" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "TimeoutMillis": { - "type": "number" - }, - "UnhealthyThreshold": { - "type": "number" - } - }, - "required": [ - "HealthyThreshold", - "IntervalMillis", - "Protocol", - "TimeoutMillis", - "UnhealthyThreshold" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.HttpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - }, - "PerRequest": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.Listener": { - "additionalProperties": false, - "properties": { - "ConnectionPool": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeConnectionPool" - }, - "HealthCheck": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.HealthCheck" - }, - "OutlierDetection": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.OutlierDetection" - }, - "PortMapping": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.PortMapping" - }, - "TLS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTls" - }, - "Timeout": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTimeout" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTimeout": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.GrpcTimeout" - }, - "HTTP": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.HttpTimeout" - }, - "HTTP2": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.HttpTimeout" - }, - "TCP": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TcpTimeout" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTls": { - "additionalProperties": false, - "properties": { - "Certificate": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsCertificate" - }, - "Mode": { - "type": "string" - }, - "Validation": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsValidationContext" - } - }, - "required": [ - "Certificate", - "Mode" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsCertificate": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsAcmCertificate" - }, - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsSdsCertificate" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsFileCertificate": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "required": [ - "CertificateChain", - "PrivateKey" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsSdsCertificate": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ListenerTlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ListenerTlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.Logging": { - "additionalProperties": false, - "properties": { - "AccessLog": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.AccessLog" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.OutlierDetection": { - "additionalProperties": false, - "properties": { - "BaseEjectionDuration": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - }, - "Interval": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - }, - "MaxEjectionPercent": { - "type": "number" - }, - "MaxServerErrors": { - "type": "number" - } - }, - "required": [ - "BaseEjectionDuration", - "Interval", - "MaxEjectionPercent", - "MaxServerErrors" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.PortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.ServiceDiscovery": { - "additionalProperties": false, - "properties": { - "AWSCloudMap": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.AwsCloudMapServiceDiscovery" - }, - "DNS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.DnsServiceDiscovery" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.SubjectAlternativeNameMatchers": { - "additionalProperties": false, - "properties": { - "Exact": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.SubjectAlternativeNames": { - "additionalProperties": false, - "properties": { - "Match": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.SubjectAlternativeNameMatchers" - } - }, - "required": [ - "Match" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TcpTimeout": { - "additionalProperties": false, - "properties": { - "Idle": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Duration" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TlsValidationContext": { - "additionalProperties": false, - "properties": { - "SubjectAlternativeNames": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.SubjectAlternativeNames" - }, - "Trust": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextTrust" - } - }, - "required": [ - "Trust" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "CertificateAuthorityArns" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust": { - "additionalProperties": false, - "properties": { - "CertificateChain": { - "type": "string" - } - }, - "required": [ - "CertificateChain" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TlsValidationContextSdsTrust": { - "additionalProperties": false, - "properties": { - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.TlsValidationContextTrust": { - "additionalProperties": false, - "properties": { - "ACM": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextAcmTrust" - }, - "File": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextFileTrust" - }, - "SDS": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.TlsValidationContextSdsTrust" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeConnectionPool": { - "additionalProperties": false, - "properties": { - "GRPC": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeGrpcConnectionPool" - }, - "HTTP": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeHttpConnectionPool" - }, - "HTTP2": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeHttp2ConnectionPool" - }, - "TCP": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.VirtualNodeTcpConnectionPool" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeGrpcConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "number" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeHttp2ConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxRequests": { - "type": "number" - } - }, - "required": [ - "MaxRequests" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeHttpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "number" - }, - "MaxPendingRequests": { - "type": "number" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeSpec": { - "additionalProperties": false, - "properties": { - "BackendDefaults": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.BackendDefaults" - }, - "Backends": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Backend" - }, - "type": "array" - }, - "Listeners": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Listener" - }, - "type": "array" - }, - "Logging": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Logging" - }, - "ServiceDiscovery": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ServiceDiscovery" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualNodeTcpConnectionPool": { - "additionalProperties": false, - "properties": { - "MaxConnections": { - "type": "number" - } - }, - "required": [ - "MaxConnections" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualNode.VirtualServiceBackend": { - "additionalProperties": false, - "properties": { - "ClientPolicy": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.ClientPolicy" - }, - "VirtualServiceName": { - "type": "string" - } - }, - "required": [ - "VirtualServiceName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualRouter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::VirtualRouter.VirtualRouterSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualRouterName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::VirtualRouter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualRouter.PortMapping": { - "additionalProperties": false, - "properties": { - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Port", - "Protocol" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualRouter.VirtualRouterListener": { - "additionalProperties": false, - "properties": { - "PortMapping": { - "$ref": "#/definitions/AWS::AppMesh::VirtualRouter.PortMapping" - } - }, - "required": [ - "PortMapping" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualRouter.VirtualRouterSpec": { - "additionalProperties": false, - "properties": { - "Listeners": { - "items": { - "$ref": "#/definitions/AWS::AppMesh::VirtualRouter.VirtualRouterListener" - }, - "type": "array" - } - }, - "required": [ - "Listeners" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualService": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MeshName": { - "type": "string" - }, - "MeshOwner": { - "type": "string" - }, - "Spec": { - "$ref": "#/definitions/AWS::AppMesh::VirtualService.VirtualServiceSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VirtualServiceName": { - "type": "string" - } - }, - "required": [ - "MeshName", - "Spec", - "VirtualServiceName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppMesh::VirtualService" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualService.VirtualNodeServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualNodeName": { - "type": "string" - } - }, - "required": [ - "VirtualNodeName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualService.VirtualRouterServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualRouterName": { - "type": "string" - } - }, - "required": [ - "VirtualRouterName" - ], - "type": "object" - }, - "AWS::AppMesh::VirtualService.VirtualServiceProvider": { - "additionalProperties": false, - "properties": { - "VirtualNode": { - "$ref": "#/definitions/AWS::AppMesh::VirtualService.VirtualNodeServiceProvider" - }, - "VirtualRouter": { - "$ref": "#/definitions/AWS::AppMesh::VirtualService.VirtualRouterServiceProvider" - } - }, - "type": "object" - }, - "AWS::AppMesh::VirtualService.VirtualServiceSpec": { - "additionalProperties": false, - "properties": { - "Provider": { - "$ref": "#/definitions/AWS::AppMesh::VirtualService.VirtualServiceProvider" - } - }, - "type": "object" - }, - "AWS::AppStream::DirectoryConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ServiceAccountCredentials": { - "$ref": "#/definitions/AWS::AppStream::DirectoryConfig.ServiceAccountCredentials" - } - }, - "required": [ - "DirectoryName", - "OrganizationalUnitDistinguishedNames", - "ServiceAccountCredentials" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::DirectoryConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppStream::DirectoryConfig.ServiceAccountCredentials": { - "additionalProperties": false, - "properties": { - "AccountName": { - "type": "string" - }, - "AccountPassword": { - "type": "string" - } - }, - "required": [ - "AccountName", - "AccountPassword" - ], - "type": "object" - }, - "AWS::AppStream::Fleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ComputeCapacity": { - "$ref": "#/definitions/AWS::AppStream::Fleet.ComputeCapacity" - }, - "Description": { - "type": "string" - }, - "DisconnectTimeoutInSeconds": { - "type": "number" - }, - "DisplayName": { - "type": "string" - }, - "DomainJoinInfo": { - "$ref": "#/definitions/AWS::AppStream::Fleet.DomainJoinInfo" - }, - "EnableDefaultInternetAccess": { - "type": "boolean" - }, - "FleetType": { - "type": "string" - }, - "IamRoleArn": { - "type": "string" - }, - "IdleDisconnectTimeoutInSeconds": { - "type": "number" - }, - "ImageArn": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "MaxUserDurationInSeconds": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "StreamView": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::AppStream::Fleet.VpcConfig" - } - }, - "required": [ - "ComputeCapacity", - "InstanceType", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::Fleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppStream::Fleet.ComputeCapacity": { - "additionalProperties": false, - "properties": { - "DesiredInstances": { - "type": "number" - } - }, - "required": [ - "DesiredInstances" - ], - "type": "object" - }, - "AWS::AppStream::Fleet.DomainJoinInfo": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppStream::Fleet.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppStream::ImageBuilder": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessEndpoints": { - "items": { - "$ref": "#/definitions/AWS::AppStream::ImageBuilder.AccessEndpoint" - }, - "type": "array" - }, - "AppstreamAgentVersion": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "DomainJoinInfo": { - "$ref": "#/definitions/AWS::AppStream::ImageBuilder.DomainJoinInfo" - }, - "EnableDefaultInternetAccess": { - "type": "boolean" - }, - "IamRoleArn": { - "type": "string" - }, - "ImageArn": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::AppStream::ImageBuilder.VpcConfig" - } - }, - "required": [ - "InstanceType", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::ImageBuilder" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppStream::ImageBuilder.AccessEndpoint": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "type": "string" - }, - "VpceId": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "VpceId" - ], - "type": "object" - }, - "AWS::AppStream::ImageBuilder.DomainJoinInfo": { - "additionalProperties": false, - "properties": { - "DirectoryName": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppStream::ImageBuilder.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppStream::Stack": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessEndpoints": { - "items": { - "$ref": "#/definitions/AWS::AppStream::Stack.AccessEndpoint" - }, - "type": "array" - }, - "ApplicationSettings": { - "$ref": "#/definitions/AWS::AppStream::Stack.ApplicationSettings" - }, - "AttributesToDelete": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DeleteStorageConnectors": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "EmbedHostDomains": { - "items": { - "type": "string" - }, - "type": "array" - }, - "FeedbackURL": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RedirectURL": { - "type": "string" - }, - "StorageConnectors": { - "items": { - "$ref": "#/definitions/AWS::AppStream::Stack.StorageConnector" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserSettings": { - "items": { - "$ref": "#/definitions/AWS::AppStream::Stack.UserSetting" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::Stack" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::AppStream::Stack.AccessEndpoint": { - "additionalProperties": false, - "properties": { - "EndpointType": { - "type": "string" - }, - "VpceId": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "VpceId" - ], - "type": "object" - }, - "AWS::AppStream::Stack.ApplicationSettings": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "SettingsGroup": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::AppStream::Stack.StorageConnector": { - "additionalProperties": false, - "properties": { - "ConnectorType": { - "type": "string" - }, - "Domains": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ResourceIdentifier": { - "type": "string" - } - }, - "required": [ - "ConnectorType" - ], - "type": "object" - }, - "AWS::AppStream::Stack.UserSetting": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Permission": { - "type": "string" - } - }, - "required": [ - "Action", - "Permission" - ], - "type": "object" - }, - "AWS::AppStream::StackFleetAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FleetName": { - "type": "string" - }, - "StackName": { - "type": "string" - } - }, - "required": [ - "FleetName", - "StackName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::StackFleetAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppStream::StackUserAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationType": { - "type": "string" - }, - "SendEmailNotification": { - "type": "boolean" - }, - "StackName": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "required": [ - "AuthenticationType", - "StackName", - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::StackUserAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppStream::User": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationType": { - "type": "string" - }, - "FirstName": { - "type": "string" - }, - "LastName": { - "type": "string" - }, - "MessageAction": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "required": [ - "AuthenticationType", - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppStream::User" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::ApiCache": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiCachingBehavior": { - "type": "string" - }, - "ApiId": { - "type": "string" - }, - "AtRestEncryptionEnabled": { - "type": "boolean" - }, - "TransitEncryptionEnabled": { - "type": "boolean" - }, - "Ttl": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ApiCachingBehavior", - "ApiId", - "Ttl", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::ApiCache" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::ApiKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "ApiKeyId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Expires": { - "type": "number" - } - }, - "required": [ - "ApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::ApiKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::DataSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DynamoDBConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.DynamoDBConfig" - }, - "ElasticsearchConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.ElasticsearchConfig" - }, - "HttpConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.HttpConfig" - }, - "LambdaConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.LambdaConfig" - }, - "Name": { - "type": "string" - }, - "RelationalDatabaseConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.RelationalDatabaseConfig" - }, - "ServiceRoleArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ApiId", - "Name", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::DataSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.AuthorizationConfig": { - "additionalProperties": false, - "properties": { - "AuthorizationType": { - "type": "string" - }, - "AwsIamConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.AwsIamConfig" - } - }, - "required": [ - "AuthorizationType" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.AwsIamConfig": { - "additionalProperties": false, - "properties": { - "SigningRegion": { - "type": "string" - }, - "SigningServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::DataSource.DeltaSyncConfig": { - "additionalProperties": false, - "properties": { - "BaseTableTTL": { - "type": "string" - }, - "DeltaSyncTableName": { - "type": "string" - }, - "DeltaSyncTableTTL": { - "type": "string" - } - }, - "required": [ - "BaseTableTTL", - "DeltaSyncTableName", - "DeltaSyncTableTTL" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.DynamoDBConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "DeltaSyncConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.DeltaSyncConfig" - }, - "TableName": { - "type": "string" - }, - "UseCallerCredentials": { - "type": "boolean" - }, - "Versioned": { - "type": "boolean" - } - }, - "required": [ - "AwsRegion", - "TableName" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.ElasticsearchConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "Endpoint": { - "type": "string" - } - }, - "required": [ - "AwsRegion", - "Endpoint" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.HttpConfig": { - "additionalProperties": false, - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.AuthorizationConfig" - }, - "Endpoint": { - "type": "string" - } - }, - "required": [ - "Endpoint" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.LambdaConfig": { - "additionalProperties": false, - "properties": { - "LambdaFunctionArn": { - "type": "string" - } - }, - "required": [ - "LambdaFunctionArn" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.RdsHttpEndpointConfig": { - "additionalProperties": false, - "properties": { - "AwsRegion": { - "type": "string" - }, - "AwsSecretStoreArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DbClusterIdentifier": { - "type": "string" - }, - "Schema": { - "type": "string" - } - }, - "required": [ - "AwsRegion", - "AwsSecretStoreArn", - "DbClusterIdentifier" - ], - "type": "object" - }, - "AWS::AppSync::DataSource.RelationalDatabaseConfig": { - "additionalProperties": false, - "properties": { - "RdsHttpEndpointConfig": { - "$ref": "#/definitions/AWS::AppSync::DataSource.RdsHttpEndpointConfig" - }, - "RelationalDatabaseSourceType": { - "type": "string" - } - }, - "required": [ - "RelationalDatabaseSourceType" - ], - "type": "object" - }, - "AWS::AppSync::FunctionConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "DataSourceName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FunctionVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RequestMappingTemplate": { - "type": "string" - }, - "RequestMappingTemplateS3Location": { - "type": "string" - }, - "ResponseMappingTemplate": { - "type": "string" - }, - "ResponseMappingTemplateS3Location": { - "type": "string" - }, - "SyncConfig": { - "$ref": "#/definitions/AWS::AppSync::FunctionConfiguration.SyncConfig" - } - }, - "required": [ - "ApiId", - "DataSourceName", - "FunctionVersion", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::FunctionConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::FunctionConfiguration.LambdaConflictHandlerConfig": { - "additionalProperties": false, - "properties": { - "LambdaConflictHandlerArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::FunctionConfiguration.SyncConfig": { - "additionalProperties": false, - "properties": { - "ConflictDetection": { - "type": "string" - }, - "ConflictHandler": { - "type": "string" - }, - "LambdaConflictHandlerConfig": { - "$ref": "#/definitions/AWS::AppSync::FunctionConfiguration.LambdaConflictHandlerConfig" - } - }, - "required": [ - "ConflictDetection" - ], - "type": "object" - }, - "AWS::AppSync::GraphQLApi": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdditionalAuthenticationProviders": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.AdditionalAuthenticationProviders" - }, - "AuthenticationType": { - "type": "string" - }, - "LambdaAuthorizerConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.LambdaAuthorizerConfig" - }, - "LogConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.LogConfig" - }, - "Name": { - "type": "string" - }, - "OpenIDConnectConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.OpenIDConnectConfig" - }, - "Tags": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.Tags" - }, - "UserPoolConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.UserPoolConfig" - }, - "XrayEnabled": { - "type": "boolean" - } - }, - "required": [ - "AuthenticationType", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::GraphQLApi" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::GraphQLApi.AdditionalAuthenticationProvider": { - "additionalProperties": false, - "properties": { - "AuthenticationType": { - "type": "string" - }, - "LambdaAuthorizerConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.LambdaAuthorizerConfig" - }, - "OpenIDConnectConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.OpenIDConnectConfig" - }, - "UserPoolConfig": { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi.CognitoUserPoolConfig" - } - }, - "required": [ - "AuthenticationType" - ], - "type": "object" - }, - "AWS::AppSync::GraphQLApi.AdditionalAuthenticationProviders": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.CognitoUserPoolConfig": { - "additionalProperties": false, - "properties": { - "AppIdClientRegex": { - "type": "string" - }, - "AwsRegion": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.LambdaAuthorizerConfig": { - "additionalProperties": false, - "properties": { - "AuthorizerResultTtlInSeconds": { - "type": "number" - }, - "AuthorizerUri": { - "type": "string" - }, - "IdentityValidationExpression": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.LogConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsRoleArn": { - "type": "string" - }, - "ExcludeVerboseContent": { - "type": "boolean" - }, - "FieldLogLevel": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.OpenIDConnectConfig": { - "additionalProperties": false, - "properties": { - "AuthTTL": { - "type": "number" - }, - "ClientId": { - "type": "string" - }, - "IatTTL": { - "type": "number" - }, - "Issuer": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.Tags": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::AppSync::GraphQLApi.UserPoolConfig": { - "additionalProperties": false, - "properties": { - "AppIdClientRegex": { - "type": "string" - }, - "AwsRegion": { - "type": "string" - }, - "DefaultAction": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::GraphQLSchema": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "Definition": { - "type": "string" - }, - "DefinitionS3Location": { - "type": "string" - } - }, - "required": [ - "ApiId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::GraphQLSchema" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::Resolver": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiId": { - "type": "string" - }, - "CachingConfig": { - "$ref": "#/definitions/AWS::AppSync::Resolver.CachingConfig" - }, - "DataSourceName": { - "type": "string" - }, - "FieldName": { - "type": "string" - }, - "Kind": { - "type": "string" - }, - "PipelineConfig": { - "$ref": "#/definitions/AWS::AppSync::Resolver.PipelineConfig" - }, - "RequestMappingTemplate": { - "type": "string" - }, - "RequestMappingTemplateS3Location": { - "type": "string" - }, - "ResponseMappingTemplate": { - "type": "string" - }, - "ResponseMappingTemplateS3Location": { - "type": "string" - }, - "SyncConfig": { - "$ref": "#/definitions/AWS::AppSync::Resolver.SyncConfig" - }, - "TypeName": { - "type": "string" - } - }, - "required": [ - "ApiId", - "FieldName", - "TypeName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AppSync::Resolver" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AppSync::Resolver.CachingConfig": { - "additionalProperties": false, - "properties": { - "CachingKeys": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Ttl": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::AppSync::Resolver.LambdaConflictHandlerConfig": { - "additionalProperties": false, - "properties": { - "LambdaConflictHandlerArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AppSync::Resolver.PipelineConfig": { - "additionalProperties": false, - "properties": { - "Functions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AppSync::Resolver.SyncConfig": { - "additionalProperties": false, - "properties": { - "ConflictDetection": { - "type": "string" - }, - "ConflictHandler": { - "type": "string" - }, - "LambdaConflictHandlerConfig": { - "$ref": "#/definitions/AWS::AppSync::Resolver.LambdaConflictHandlerConfig" - } - }, - "required": [ - "ConflictDetection" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalableTarget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - }, - "ResourceId": { - "type": "string" - }, - "RoleARN": { - "type": "string" - }, - "ScalableDimension": { - "type": "string" - }, - "ScheduledActions": { - "items": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalableTarget.ScheduledAction" - }, - "type": "array" - }, - "ServiceNamespace": { - "type": "string" - }, - "SuspendedState": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalableTarget.SuspendedState" - } - }, - "required": [ - "MaxCapacity", - "MinCapacity", - "ResourceId", - "RoleARN", - "ScalableDimension", - "ServiceNamespace" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApplicationAutoScaling::ScalableTarget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalableTarget.ScalableTargetAction": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalableTarget.ScheduledAction": { - "additionalProperties": false, - "properties": { - "EndTime": { - "type": "string" - }, - "ScalableTargetAction": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalableTarget.ScalableTargetAction" - }, - "Schedule": { - "type": "string" - }, - "ScheduledActionName": { - "type": "string" - }, - "StartTime": { - "type": "string" - } - }, - "required": [ - "Schedule", - "ScheduledActionName" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalableTarget.SuspendedState": { - "additionalProperties": false, - "properties": { - "DynamicScalingInSuspended": { - "type": "boolean" - }, - "DynamicScalingOutSuspended": { - "type": "boolean" - }, - "ScheduledScalingSuspended": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyName": { - "type": "string" - }, - "PolicyType": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "ScalableDimension": { - "type": "string" - }, - "ScalingTargetId": { - "type": "string" - }, - "ServiceNamespace": { - "type": "string" - }, - "StepScalingPolicyConfiguration": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration" - }, - "TargetTrackingScalingPolicyConfiguration": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration" - } - }, - "required": [ - "PolicyName", - "PolicyType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApplicationAutoScaling::ScalingPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace", - "Statistic" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.MetricDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment": { - "additionalProperties": false, - "properties": { - "MetricIntervalLowerBound": { - "type": "number" - }, - "MetricIntervalUpperBound": { - "type": "number" - }, - "ScalingAdjustment": { - "type": "number" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.StepScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "Cooldown": { - "type": "number" - }, - "MetricAggregationType": { - "type": "string" - }, - "MinAdjustmentMagnitude": { - "type": "number" - }, - "StepAdjustments": { - "items": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.StepAdjustment" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApplicationAutoScaling::ScalingPolicy.TargetTrackingScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "CustomizedMetricSpecification": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.CustomizedMetricSpecification" - }, - "DisableScaleIn": { - "type": "boolean" - }, - "PredefinedMetricSpecification": { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy.PredefinedMetricSpecification" - }, - "ScaleInCooldown": { - "type": "number" - }, - "ScaleOutCooldown": { - "type": "number" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoConfigurationEnabled": { - "type": "boolean" - }, - "CWEMonitorEnabled": { - "type": "boolean" - }, - "ComponentMonitoringSettings": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.ComponentMonitoringSetting" - }, - "type": "array" - }, - "CustomComponents": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.CustomComponent" - }, - "type": "array" - }, - "LogPatternSets": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.LogPatternSet" - }, - "type": "array" - }, - "OpsCenterEnabled": { - "type": "boolean" - }, - "OpsItemSNSTopicArn": { - "type": "string" - }, - "ResourceGroupName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ResourceGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ApplicationInsights::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.Alarm": { - "additionalProperties": false, - "properties": { - "AlarmName": { - "type": "string" - }, - "Severity": { - "type": "string" - } - }, - "required": [ - "AlarmName" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.AlarmMetric": { - "additionalProperties": false, - "properties": { - "AlarmMetricName": { - "type": "string" - } - }, - "required": [ - "AlarmMetricName" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.ComponentConfiguration": { - "additionalProperties": false, - "properties": { - "ConfigurationDetails": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.ConfigurationDetails" - }, - "SubComponentTypeConfigurations": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.SubComponentTypeConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApplicationInsights::Application.ComponentMonitoringSetting": { - "additionalProperties": false, - "properties": { - "ComponentARN": { - "type": "string" - }, - "ComponentConfigurationMode": { - "type": "string" - }, - "ComponentName": { - "type": "string" - }, - "CustomComponentConfiguration": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.ComponentConfiguration" - }, - "DefaultOverwriteComponentConfiguration": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.ComponentConfiguration" - }, - "Tier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApplicationInsights::Application.ConfigurationDetails": { - "additionalProperties": false, - "properties": { - "AlarmMetrics": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.AlarmMetric" - }, - "type": "array" - }, - "Alarms": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.Alarm" - }, - "type": "array" - }, - "JMXPrometheusExporter": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.JMXPrometheusExporter" - }, - "Logs": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.Log" - }, - "type": "array" - }, - "WindowsEvents": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.WindowsEvent" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApplicationInsights::Application.CustomComponent": { - "additionalProperties": false, - "properties": { - "ComponentName": { - "type": "string" - }, - "ResourceList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ComponentName", - "ResourceList" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.JMXPrometheusExporter": { - "additionalProperties": false, - "properties": { - "HostPort": { - "type": "string" - }, - "JMXURL": { - "type": "string" - }, - "PrometheusPort": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ApplicationInsights::Application.Log": { - "additionalProperties": false, - "properties": { - "Encoding": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "LogPath": { - "type": "string" - }, - "LogType": { - "type": "string" - }, - "PatternSet": { - "type": "string" - } - }, - "required": [ - "LogType" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.LogPattern": { - "additionalProperties": false, - "properties": { - "Pattern": { - "type": "string" - }, - "PatternName": { - "type": "string" - }, - "Rank": { - "type": "number" - } - }, - "required": [ - "Pattern", - "PatternName", - "Rank" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.LogPatternSet": { - "additionalProperties": false, - "properties": { - "LogPatterns": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.LogPattern" - }, - "type": "array" - }, - "PatternSetName": { - "type": "string" - } - }, - "required": [ - "LogPatterns", - "PatternSetName" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.SubComponentConfigurationDetails": { - "additionalProperties": false, - "properties": { - "AlarmMetrics": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.AlarmMetric" - }, - "type": "array" - }, - "Logs": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.Log" - }, - "type": "array" - }, - "WindowsEvents": { - "items": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.WindowsEvent" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ApplicationInsights::Application.SubComponentTypeConfiguration": { - "additionalProperties": false, - "properties": { - "SubComponentConfigurationDetails": { - "$ref": "#/definitions/AWS::ApplicationInsights::Application.SubComponentConfigurationDetails" - }, - "SubComponentType": { - "type": "string" - } - }, - "required": [ - "SubComponentConfigurationDetails", - "SubComponentType" - ], - "type": "object" - }, - "AWS::ApplicationInsights::Application.WindowsEvent": { - "additionalProperties": false, - "properties": { - "EventLevels": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EventName": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "PatternSet": { - "type": "string" - } - }, - "required": [ - "EventLevels", - "EventName", - "LogGroupName" - ], - "type": "object" - }, - "AWS::Athena::DataCatalog": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Athena::DataCatalog" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Athena::NamedQuery": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Database": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "QueryString": { - "type": "string" - }, - "WorkGroup": { - "type": "string" - } - }, - "required": [ - "Database", - "QueryString" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Athena::NamedQuery" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Athena::WorkGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RecursiveDeleteOption": { - "type": "boolean" - }, - "State": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "WorkGroupConfiguration": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.WorkGroupConfiguration" - }, - "WorkGroupConfigurationUpdates": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.WorkGroupConfigurationUpdates" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Athena::WorkGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Athena::WorkGroup.EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "EncryptionOption": { - "type": "string" - }, - "KmsKey": { - "type": "string" - } - }, - "required": [ - "EncryptionOption" - ], - "type": "object" - }, - "AWS::Athena::WorkGroup.EngineVersion": { - "additionalProperties": false, - "properties": { - "EffectiveEngineVersion": { - "type": "string" - }, - "SelectedEngineVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Athena::WorkGroup.ResultConfiguration": { - "additionalProperties": false, - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.EncryptionConfiguration" - }, - "OutputLocation": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Athena::WorkGroup.ResultConfigurationUpdates": { - "additionalProperties": false, - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.EncryptionConfiguration" - }, - "OutputLocation": { - "type": "string" - }, - "RemoveEncryptionConfiguration": { - "type": "boolean" - }, - "RemoveOutputLocation": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Athena::WorkGroup.WorkGroupConfiguration": { - "additionalProperties": false, - "properties": { - "BytesScannedCutoffPerQuery": { - "type": "number" - }, - "EnforceWorkGroupConfiguration": { - "type": "boolean" - }, - "EngineVersion": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.EngineVersion" - }, - "PublishCloudWatchMetricsEnabled": { - "type": "boolean" - }, - "RequesterPaysEnabled": { - "type": "boolean" - }, - "ResultConfiguration": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.ResultConfiguration" - } - }, - "type": "object" - }, - "AWS::Athena::WorkGroup.WorkGroupConfigurationUpdates": { - "additionalProperties": false, - "properties": { - "BytesScannedCutoffPerQuery": { - "type": "number" - }, - "EnforceWorkGroupConfiguration": { - "type": "boolean" - }, - "EngineVersion": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.EngineVersion" - }, - "PublishCloudWatchMetricsEnabled": { - "type": "boolean" - }, - "RemoveBytesScannedCutoffPerQuery": { - "type": "boolean" - }, - "RequesterPaysEnabled": { - "type": "boolean" - }, - "ResultConfigurationUpdates": { - "$ref": "#/definitions/AWS::Athena::WorkGroup.ResultConfigurationUpdates" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssessmentReportsDestination": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.AssessmentReportsDestination" - }, - "AwsAccount": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.AWSAccount" - }, - "Description": { - "type": "string" - }, - "FrameworkId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Roles": { - "items": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.Role" - }, - "type": "array" - }, - "Scope": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.Scope" - }, - "Status": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AuditManager::Assessment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::AuditManager::Assessment.AWSAccount": { - "additionalProperties": false, - "properties": { - "EmailAddress": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment.AWSService": { - "additionalProperties": false, - "properties": { - "ServiceName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment.AssessmentReportsDestination": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - }, - "DestinationType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment.Delegation": { - "additionalProperties": false, - "properties": { - "AssessmentId": { - "type": "string" - }, - "AssessmentName": { - "type": "string" - }, - "Comment": { - "type": "string" - }, - "ControlSetId": { - "type": "string" - }, - "CreatedBy": { - "type": "string" - }, - "CreationTime": { - "type": "number" - }, - "Id": { - "type": "string" - }, - "LastUpdated": { - "type": "number" - }, - "RoleArn": { - "type": "string" - }, - "RoleType": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment.Role": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "RoleType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AuditManager::Assessment.Scope": { - "additionalProperties": false, - "properties": { - "AwsAccounts": { - "items": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.AWSAccount" - }, - "type": "array" - }, - "AwsServices": { - "items": { - "$ref": "#/definitions/AWS::AuditManager::Assessment.AWSService" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup": { - "additionalProperties": false, - "properties": { - "CreationPolicy": { - "type": "object" - }, - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupName": { - "type": "string" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CapacityRebalance": { - "type": "boolean" - }, - "Cooldown": { - "type": "string" - }, - "DesiredCapacity": { - "type": "string" - }, - "HealthCheckGracePeriod": { - "type": "number" - }, - "HealthCheckType": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "LaunchConfigurationName": { - "type": "string" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification" - }, - "LifecycleHookSpecificationList": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification" - }, - "type": "array" - }, - "LoadBalancerNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxInstanceLifetime": { - "type": "number" - }, - "MaxSize": { - "type": "string" - }, - "MetricsCollection": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.MetricsCollection" - }, - "type": "array" - }, - "MinSize": { - "type": "string" - }, - "MixedInstancesPolicy": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy" - }, - "NewInstancesProtectedFromScaleIn": { - "type": "boolean" - }, - "NotificationConfigurations": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration" - }, - "type": "array" - }, - "PlacementGroup": { - "type": "string" - }, - "ServiceLinkedRoleARN": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.TagProperty" - }, - "type": "array" - }, - "TargetGroupARNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TerminationPolicies": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VPCZoneIdentifier": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "MaxSize", - "MinSize" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScaling::AutoScalingGroup" - ], - "type": "string" - }, - "UpdatePolicy": { - "type": "object" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.InstancesDistribution": { - "additionalProperties": false, - "properties": { - "OnDemandAllocationStrategy": { - "type": "string" - }, - "OnDemandBaseCapacity": { - "type": "number" - }, - "OnDemandPercentageAboveBaseCapacity": { - "type": "number" - }, - "SpotAllocationStrategy": { - "type": "string" - }, - "SpotInstancePools": { - "type": "number" - }, - "SpotMaxPrice": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.LaunchTemplate": { - "additionalProperties": false, - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides" - }, - "type": "array" - } - }, - "required": [ - "LaunchTemplateSpecification" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "type": "string" - }, - "LaunchTemplateSpecification": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification" - }, - "WeightedCapacity": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification": { - "additionalProperties": false, - "properties": { - "DefaultResult": { - "type": "string" - }, - "HeartbeatTimeout": { - "type": "number" - }, - "LifecycleHookName": { - "type": "string" - }, - "LifecycleTransition": { - "type": "string" - }, - "NotificationMetadata": { - "type": "string" - }, - "NotificationTargetARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "LifecycleHookName", - "LifecycleTransition" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.MetricsCollection": { - "additionalProperties": false, - "properties": { - "Granularity": { - "type": "string" - }, - "Metrics": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Granularity" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy": { - "additionalProperties": false, - "properties": { - "InstancesDistribution": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.InstancesDistribution" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup.LaunchTemplate" - } - }, - "required": [ - "LaunchTemplate" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration": { - "additionalProperties": false, - "properties": { - "NotificationTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TopicARN": { - "type": "string" - } - }, - "required": [ - "TopicARN" - ], - "type": "object" - }, - "AWS::AutoScaling::AutoScalingGroup.TagProperty": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "PropagateAtLaunch": { - "type": "boolean" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "PropagateAtLaunch", - "Value" - ], - "type": "object" - }, - "AWS::AutoScaling::LaunchConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping" - }, - "type": "array" - }, - "ClassicLinkVPCId": { - "type": "string" - }, - "ClassicLinkVPCSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - }, - "IamInstanceProfile": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "InstanceMonitoring": { - "type": "boolean" - }, - "InstanceType": { - "type": "string" - }, - "KernelId": { - "type": "string" - }, - "KeyName": { - "type": "string" - }, - "LaunchConfigurationName": { - "type": "string" - }, - "MetadataOptions": { - "$ref": "#/definitions/AWS::AutoScaling::LaunchConfiguration.MetadataOptions" - }, - "PlacementTenancy": { - "type": "string" - }, - "RamDiskId": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SpotPrice": { - "type": "string" - }, - "UserData": { - "type": "string" - } - }, - "required": [ - "ImageId", - "InstanceType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScaling::LaunchConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScaling::LaunchConfiguration.BlockDevice": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AutoScaling::LaunchConfiguration.BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::AutoScaling::LaunchConfiguration.BlockDevice" - }, - "NoDevice": { - "type": "boolean" - }, - "VirtualName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "AWS::AutoScaling::LaunchConfiguration.MetadataOptions": { - "additionalProperties": false, - "properties": { - "HttpEndpoint": { - "type": "string" - }, - "HttpPutResponseHopLimit": { - "type": "number" - }, - "HttpTokens": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::AutoScaling::LifecycleHook": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupName": { - "type": "string" - }, - "DefaultResult": { - "type": "string" - }, - "HeartbeatTimeout": { - "type": "number" - }, - "LifecycleHookName": { - "type": "string" - }, - "LifecycleTransition": { - "type": "string" - }, - "NotificationMetadata": { - "type": "string" - }, - "NotificationTargetARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "AutoScalingGroupName", - "LifecycleTransition" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScaling::LifecycleHook" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "AutoScalingGroupName": { - "type": "string" - }, - "Cooldown": { - "type": "string" - }, - "EstimatedInstanceWarmup": { - "type": "number" - }, - "MetricAggregationType": { - "type": "string" - }, - "MinAdjustmentMagnitude": { - "type": "number" - }, - "PolicyType": { - "type": "string" - }, - "ScalingAdjustment": { - "type": "number" - }, - "StepAdjustments": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.StepAdjustment" - }, - "type": "array" - }, - "TargetTrackingConfiguration": { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration" - } - }, - "required": [ - "AutoScalingGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScaling::ScalingPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.MetricDimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace", - "Statistic" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy.MetricDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedMetricType" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy.StepAdjustment": { - "additionalProperties": false, - "properties": { - "MetricIntervalLowerBound": { - "type": "number" - }, - "MetricIntervalUpperBound": { - "type": "number" - }, - "ScalingAdjustment": { - "type": "number" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "AWS::AutoScaling::ScalingPolicy.TargetTrackingConfiguration": { - "additionalProperties": false, - "properties": { - "CustomizedMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.CustomizedMetricSpecification" - }, - "DisableScaleIn": { - "type": "boolean" - }, - "PredefinedMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredefinedMetricSpecification" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "AWS::AutoScaling::ScheduledAction": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupName": { - "type": "string" - }, - "DesiredCapacity": { - "type": "number" - }, - "EndTime": { - "type": "string" - }, - "MaxSize": { - "type": "number" - }, - "MinSize": { - "type": "number" - }, - "Recurrence": { - "type": "string" - }, - "StartTime": { - "type": "string" - } - }, - "required": [ - "AutoScalingGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScaling::ScheduledAction" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationSource": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.ApplicationSource" - }, - "ScalingInstructions": { - "items": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction" - }, - "type": "array" - } - }, - "required": [ - "ApplicationSource", - "ScalingInstructions" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::AutoScalingPlans::ScalingPlan" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.ApplicationSource": { - "additionalProperties": false, - "properties": { - "CloudFormationStackARN": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.MetricDimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace", - "Statistic" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.MetricDimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Statistic": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace", - "Statistic" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.MetricDimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedLoadMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedLoadMetricType" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification": { - "additionalProperties": false, - "properties": { - "PredefinedScalingMetricType": { - "type": "string" - }, - "ResourceLabel": { - "type": "string" - } - }, - "required": [ - "PredefinedScalingMetricType" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.ScalingInstruction": { - "additionalProperties": false, - "properties": { - "CustomizedLoadMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.CustomizedLoadMetricSpecification" - }, - "DisableDynamicScaling": { - "type": "boolean" - }, - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - }, - "PredefinedLoadMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.PredefinedLoadMetricSpecification" - }, - "PredictiveScalingMaxCapacityBehavior": { - "type": "string" - }, - "PredictiveScalingMaxCapacityBuffer": { - "type": "number" - }, - "PredictiveScalingMode": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "ScalableDimension": { - "type": "string" - }, - "ScalingPolicyUpdateBehavior": { - "type": "string" - }, - "ScheduledActionBufferTime": { - "type": "number" - }, - "ServiceNamespace": { - "type": "string" - }, - "TargetTrackingConfigurations": { - "items": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration" - }, - "type": "array" - } - }, - "required": [ - "MaxCapacity", - "MinCapacity", - "ResourceId", - "ScalableDimension", - "ServiceNamespace", - "TargetTrackingConfigurations" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "AWS::AutoScalingPlans::ScalingPlan.TargetTrackingConfiguration": { - "additionalProperties": false, - "properties": { - "CustomizedScalingMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.CustomizedScalingMetricSpecification" - }, - "DisableScaleIn": { - "type": "boolean" - }, - "EstimatedInstanceWarmup": { - "type": "number" - }, - "PredefinedScalingMetricSpecification": { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.PredefinedScalingMetricSpecification" - }, - "ScaleInCooldown": { - "type": "number" - }, - "ScaleOutCooldown": { - "type": "number" - }, - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BackupPlan": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.BackupPlanResourceType" - }, - "BackupPlanTags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "BackupPlan" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Backup::BackupPlan" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan.AdvancedBackupSettingResourceType": { - "additionalProperties": false, - "properties": { - "BackupOptions": { - "type": "object" - }, - "ResourceType": { - "type": "string" - } - }, - "required": [ - "BackupOptions", - "ResourceType" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan.BackupPlanResourceType": { - "additionalProperties": false, - "properties": { - "AdvancedBackupSettings": { - "items": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.AdvancedBackupSettingResourceType" - }, - "type": "array" - }, - "BackupPlanName": { - "type": "string" - }, - "BackupPlanRule": { - "items": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.BackupRuleResourceType" - }, - "type": "array" - } - }, - "required": [ - "BackupPlanName", - "BackupPlanRule" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan.BackupRuleResourceType": { - "additionalProperties": false, - "properties": { - "CompletionWindowMinutes": { - "type": "number" - }, - "CopyActions": { - "items": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.CopyActionResourceType" - }, - "type": "array" - }, - "Lifecycle": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.LifecycleResourceType" - }, - "RecoveryPointTags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "RuleName": { - "type": "string" - }, - "ScheduleExpression": { - "type": "string" - }, - "StartWindowMinutes": { - "type": "number" - }, - "TargetBackupVault": { - "type": "string" - } - }, - "required": [ - "RuleName", - "TargetBackupVault" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan.CopyActionResourceType": { - "additionalProperties": false, - "properties": { - "DestinationBackupVaultArn": { - "type": "string" - }, - "Lifecycle": { - "$ref": "#/definitions/AWS::Backup::BackupPlan.LifecycleResourceType" - } - }, - "required": [ - "DestinationBackupVaultArn" - ], - "type": "object" - }, - "AWS::Backup::BackupPlan.LifecycleResourceType": { - "additionalProperties": false, - "properties": { - "DeleteAfterDays": { - "type": "number" - }, - "MoveToColdStorageAfterDays": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Backup::BackupSelection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BackupPlanId": { - "type": "string" - }, - "BackupSelection": { - "$ref": "#/definitions/AWS::Backup::BackupSelection.BackupSelectionResourceType" - } - }, - "required": [ - "BackupPlanId", - "BackupSelection" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Backup::BackupSelection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Backup::BackupSelection.BackupSelectionResourceType": { - "additionalProperties": false, - "properties": { - "IamRoleArn": { - "type": "string" - }, - "ListOfTags": { - "items": { - "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionResourceType" - }, - "type": "array" - }, - "Resources": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SelectionName": { - "type": "string" - } - }, - "required": [ - "IamRoleArn", - "SelectionName" - ], - "type": "object" - }, - "AWS::Backup::BackupSelection.ConditionResourceType": { - "additionalProperties": false, - "properties": { - "ConditionKey": { - "type": "string" - }, - "ConditionType": { - "type": "string" - }, - "ConditionValue": { - "type": "string" - } - }, - "required": [ - "ConditionKey", - "ConditionType", - "ConditionValue" - ], - "type": "object" - }, - "AWS::Backup::BackupVault": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessPolicy": { - "type": "object" - }, - "BackupVaultName": { - "type": "string" - }, - "BackupVaultTags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "EncryptionKeyArn": { - "type": "string" - }, - "Notifications": { - "$ref": "#/definitions/AWS::Backup::BackupVault.NotificationObjectType" - } - }, - "required": [ - "BackupVaultName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Backup::BackupVault" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Backup::BackupVault.NotificationObjectType": { - "additionalProperties": false, - "properties": { - "BackupVaultEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SNSTopicArn": { - "type": "string" - } - }, - "required": [ - "BackupVaultEvents", - "SNSTopicArn" - ], - "type": "object" - }, - "AWS::Batch::ComputeEnvironment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ComputeEnvironmentName": { - "type": "string" - }, - "ComputeResources": { - "$ref": "#/definitions/AWS::Batch::ComputeEnvironment.ComputeResources" - }, - "ServiceRole": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ServiceRole", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Batch::ComputeEnvironment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Batch::ComputeEnvironment.ComputeResources": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BidPercentage": { - "type": "number" - }, - "DesiredvCpus": { - "type": "number" - }, - "Ec2Configuration": { - "items": { - "$ref": "#/definitions/AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject" - }, - "type": "array" - }, - "Ec2KeyPair": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceRole": { - "type": "string" - }, - "InstanceTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification" - }, - "MaxvCpus": { - "type": "number" - }, - "MinvCpus": { - "type": "number" - }, - "PlacementGroup": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SpotIamFleetRole": { - "type": "string" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "type": "object" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "MaxvCpus", - "Subnets", - "Type" - ], - "type": "object" - }, - "AWS::Batch::ComputeEnvironment.Ec2ConfigurationObject": { - "additionalProperties": false, - "properties": { - "ImageIdOverride": { - "type": "string" - }, - "ImageType": { - "type": "string" - } - }, - "required": [ - "ImageType" - ], - "type": "object" - }, - "AWS::Batch::ComputeEnvironment.LaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContainerProperties": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.ContainerProperties" - }, - "JobDefinitionName": { - "type": "string" - }, - "NodeProperties": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.NodeProperties" - }, - "Parameters": { - "type": "object" - }, - "PlatformCapabilities": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PropagateTags": { - "type": "boolean" - }, - "RetryStrategy": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.RetryStrategy" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Timeout" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Batch::JobDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.ContainerProperties": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Environment" - }, - "type": "array" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "FargatePlatformConfiguration": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.FargatePlatformConfiguration" - }, - "Image": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "JobRoleArn": { - "type": "string" - }, - "LinuxParameters": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.LinuxParameters" - }, - "LogConfiguration": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.LogConfiguration" - }, - "Memory": { - "type": "number" - }, - "MountPoints": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.MountPoints" - }, - "type": "array" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.NetworkConfiguration" - }, - "Privileged": { - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "type": "boolean" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.ResourceRequirement" - }, - "type": "array" - }, - "Secrets": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Secret" - }, - "type": "array" - }, - "Ulimits": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Ulimit" - }, - "type": "array" - }, - "User": { - "type": "string" - }, - "Vcpus": { - "type": "number" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Volumes" - }, - "type": "array" - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.Device": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "HostPath": { - "type": "string" - }, - "Permissions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.Environment": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.EvaluateOnExit": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "OnExitCode": { - "type": "string" - }, - "OnReason": { - "type": "string" - }, - "OnStatusReason": { - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.FargatePlatformConfiguration": { - "additionalProperties": false, - "properties": { - "PlatformVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.LinuxParameters": { - "additionalProperties": false, - "properties": { - "Devices": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Device" - }, - "type": "array" - }, - "InitProcessEnabled": { - "type": "boolean" - }, - "MaxSwap": { - "type": "number" - }, - "SharedMemorySize": { - "type": "number" - }, - "Swappiness": { - "type": "number" - }, - "Tmpfs": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Tmpfs" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogDriver": { - "type": "string" - }, - "Options": { - "type": "object" - }, - "SecretOptions": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.Secret" - }, - "type": "array" - } - }, - "required": [ - "LogDriver" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.MountPoints": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "SourceVolume": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.NodeProperties": { - "additionalProperties": false, - "properties": { - "MainNode": { - "type": "number" - }, - "NodeRangeProperties": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.NodeRangeProperty" - }, - "type": "array" - }, - "NumNodes": { - "type": "number" - } - }, - "required": [ - "MainNode", - "NodeRangeProperties", - "NumNodes" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.NodeRangeProperty": { - "additionalProperties": false, - "properties": { - "Container": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.ContainerProperties" - }, - "TargetNodes": { - "type": "string" - } - }, - "required": [ - "TargetNodes" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.ResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.RetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "type": "number" - }, - "EvaluateOnExit": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.EvaluateOnExit" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.Secret": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ValueFrom": { - "type": "string" - } - }, - "required": [ - "Name", - "ValueFrom" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.Timeout": { - "additionalProperties": false, - "properties": { - "AttemptDurationSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.Tmpfs": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "MountOptions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Size": { - "type": "number" - } - }, - "required": [ - "ContainerPath", - "Size" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.Ulimit": { - "additionalProperties": false, - "properties": { - "HardLimit": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "SoftLimit": { - "type": "number" - } - }, - "required": [ - "HardLimit", - "Name", - "SoftLimit" - ], - "type": "object" - }, - "AWS::Batch::JobDefinition.Volumes": { - "additionalProperties": false, - "properties": { - "Host": { - "$ref": "#/definitions/AWS::Batch::JobDefinition.VolumesHost" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobDefinition.VolumesHost": { - "additionalProperties": false, - "properties": { - "SourcePath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Batch::JobQueue": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ComputeEnvironmentOrder": { - "items": { - "$ref": "#/definitions/AWS::Batch::JobQueue.ComputeEnvironmentOrder" - }, - "type": "array" - }, - "JobQueueName": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "State": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "ComputeEnvironmentOrder", - "Priority" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Batch::JobQueue" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Batch::JobQueue.ComputeEnvironmentOrder": { - "additionalProperties": false, - "properties": { - "ComputeEnvironment": { - "type": "string" - }, - "Order": { - "type": "number" - } - }, - "required": [ - "ComputeEnvironment", - "Order" - ], - "type": "object" - }, - "AWS::Budgets::Budget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Budget": { - "$ref": "#/definitions/AWS::Budgets::Budget.BudgetData" - }, - "NotificationsWithSubscribers": { - "items": { - "$ref": "#/definitions/AWS::Budgets::Budget.NotificationWithSubscribers" - }, - "type": "array" - } - }, - "required": [ - "Budget" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Budgets::Budget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Budgets::Budget.BudgetData": { - "additionalProperties": false, - "properties": { - "BudgetLimit": { - "$ref": "#/definitions/AWS::Budgets::Budget.Spend" - }, - "BudgetName": { - "type": "string" - }, - "BudgetType": { - "type": "string" - }, - "CostFilters": { - "type": "object" - }, - "CostTypes": { - "$ref": "#/definitions/AWS::Budgets::Budget.CostTypes" - }, - "PlannedBudgetLimits": { - "type": "object" - }, - "TimePeriod": { - "$ref": "#/definitions/AWS::Budgets::Budget.TimePeriod" - }, - "TimeUnit": { - "type": "string" - } - }, - "required": [ - "BudgetType", - "TimeUnit" - ], - "type": "object" - }, - "AWS::Budgets::Budget.CostTypes": { - "additionalProperties": false, - "properties": { - "IncludeCredit": { - "type": "boolean" - }, - "IncludeDiscount": { - "type": "boolean" - }, - "IncludeOtherSubscription": { - "type": "boolean" - }, - "IncludeRecurring": { - "type": "boolean" - }, - "IncludeRefund": { - "type": "boolean" - }, - "IncludeSubscription": { - "type": "boolean" - }, - "IncludeSupport": { - "type": "boolean" - }, - "IncludeTax": { - "type": "boolean" - }, - "IncludeUpfront": { - "type": "boolean" - }, - "UseAmortized": { - "type": "boolean" - }, - "UseBlended": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Budgets::Budget.Notification": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "NotificationType": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "ThresholdType": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "NotificationType", - "Threshold" - ], - "type": "object" - }, - "AWS::Budgets::Budget.NotificationWithSubscribers": { - "additionalProperties": false, - "properties": { - "Notification": { - "$ref": "#/definitions/AWS::Budgets::Budget.Notification" - }, - "Subscribers": { - "items": { - "$ref": "#/definitions/AWS::Budgets::Budget.Subscriber" - }, - "type": "array" - } - }, - "required": [ - "Notification", - "Subscribers" - ], - "type": "object" - }, - "AWS::Budgets::Budget.Spend": { - "additionalProperties": false, - "properties": { - "Amount": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Amount", - "Unit" - ], - "type": "object" - }, - "AWS::Budgets::Budget.Subscriber": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "SubscriptionType": { - "type": "string" - } - }, - "required": [ - "Address", - "SubscriptionType" - ], - "type": "object" - }, - "AWS::Budgets::Budget.TimePeriod": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CE::AnomalyMonitor": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MonitorDimension": { - "type": "string" - }, - "MonitorName": { - "type": "string" - }, - "MonitorSpecification": { - "type": "string" - }, - "MonitorType": { - "type": "string" - } - }, - "required": [ - "MonitorName", - "MonitorType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CE::AnomalyMonitor" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CE::AnomalySubscription": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Frequency": { - "type": "string" - }, - "MonitorArnList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subscribers": { - "items": { - "$ref": "#/definitions/AWS::CE::AnomalySubscription.Subscriber" - }, - "type": "array" - }, - "SubscriptionName": { - "type": "string" - }, - "Threshold": { - "type": "number" - } - }, - "required": [ - "Frequency", - "MonitorArnList", - "Subscribers", - "SubscriptionName", - "Threshold" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CE::AnomalySubscription" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CE::AnomalySubscription.Subscriber": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Address", - "Type" - ], - "type": "object" - }, - "AWS::CE::CostCategory": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RuleVersion": { - "type": "string" - }, - "Rules": { - "type": "string" - } - }, - "required": [ - "Name", - "RuleVersion", - "Rules" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CE::CostCategory" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cassandra::Keyspace": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "KeyspaceName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cassandra::Keyspace" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Cassandra::Table": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BillingMode": { - "$ref": "#/definitions/AWS::Cassandra::Table.BillingMode" - }, - "ClusteringKeyColumns": { - "items": { - "$ref": "#/definitions/AWS::Cassandra::Table.ClusteringKeyColumn" - }, - "type": "array" - }, - "KeyspaceName": { - "type": "string" - }, - "PartitionKeyColumns": { - "items": { - "$ref": "#/definitions/AWS::Cassandra::Table.Column" - }, - "type": "array" - }, - "PointInTimeRecoveryEnabled": { - "type": "boolean" - }, - "RegularColumns": { - "items": { - "$ref": "#/definitions/AWS::Cassandra::Table.Column" - }, - "type": "array" - }, - "TableName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "KeyspaceName", - "PartitionKeyColumns" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cassandra::Table" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cassandra::Table.BillingMode": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/AWS::Cassandra::Table.ProvisionedThroughput" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "AWS::Cassandra::Table.ClusteringKeyColumn": { - "additionalProperties": false, - "properties": { - "Column": { - "$ref": "#/definitions/AWS::Cassandra::Table.Column" - }, - "OrderBy": { - "type": "string" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "AWS::Cassandra::Table.Column": { - "additionalProperties": false, - "properties": { - "ColumnName": { - "type": "string" - }, - "ColumnType": { - "type": "string" - } - }, - "required": [ - "ColumnName", - "ColumnType" - ], - "type": "object" - }, - "AWS::Cassandra::Table.ProvisionedThroughput": { - "additionalProperties": false, - "properties": { - "ReadCapacityUnits": { - "type": "number" - }, - "WriteCapacityUnits": { - "type": "number" - } - }, - "required": [ - "ReadCapacityUnits", - "WriteCapacityUnits" - ], - "type": "object" - }, - "AWS::CertificateManager::Account": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExpiryEventsConfiguration": { - "$ref": "#/definitions/AWS::CertificateManager::Account.ExpiryEventsConfiguration" - } - }, - "required": [ - "ExpiryEventsConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CertificateManager::Account" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CertificateManager::Account.ExpiryEventsConfiguration": { - "additionalProperties": false, - "properties": { - "DaysBeforeExpiry": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::CertificateManager::Certificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArn": { - "type": "string" - }, - "CertificateTransparencyLoggingPreference": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "DomainValidationOptions": { - "items": { - "$ref": "#/definitions/AWS::CertificateManager::Certificate.DomainValidationOption" - }, - "type": "array" - }, - "SubjectAlternativeNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ValidationMethod": { - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CertificateManager::Certificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CertificateManager::Certificate.DomainValidationOption": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "ValidationDomain": { - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "AWS::Chatbot::SlackChannelConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConfigurationName": { - "type": "string" - }, - "IamRoleArn": { - "type": "string" - }, - "LoggingLevel": { - "type": "string" - }, - "SlackChannelId": { - "type": "string" - }, - "SlackWorkspaceId": { - "type": "string" - }, - "SnsTopicArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ConfigurationName", - "IamRoleArn", - "SlackChannelId", - "SlackWorkspaceId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Chatbot::SlackChannelConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cloud9::EnvironmentEC2": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutomaticStopTimeMinutes": { - "type": "number" - }, - "ConnectionType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OwnerArn": { - "type": "string" - }, - "Repositories": { - "items": { - "$ref": "#/definitions/AWS::Cloud9::EnvironmentEC2.Repository" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cloud9::EnvironmentEC2" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cloud9::EnvironmentEC2.Repository": { - "additionalProperties": false, - "properties": { - "PathComponent": { - "type": "string" - }, - "RepositoryUrl": { - "type": "string" - } - }, - "required": [ - "PathComponent", - "RepositoryUrl" - ], - "type": "object" - }, - "AWS::CloudFormation::CustomResource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ServiceToken": { - "type": "string" - } - }, - "required": [ - "ServiceToken" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::CustomResource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::Macro": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "LogRoleARN": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "FunctionName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::Macro" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::ModuleDefaultVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "ModuleName": { - "type": "string" - }, - "VersionId": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::ModuleDefaultVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CloudFormation::ModuleVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ModuleName": { - "type": "string" - }, - "ModulePackage": { - "type": "string" - } - }, - "required": [ - "ModuleName", - "ModulePackage" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::ModuleVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::ResourceDefaultVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "TypeName": { - "type": "string" - }, - "TypeVersionArn": { - "type": "string" - }, - "VersionId": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::ResourceDefaultVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CloudFormation::ResourceVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExecutionRoleArn": { - "type": "string" - }, - "LoggingConfig": { - "$ref": "#/definitions/AWS::CloudFormation::ResourceVersion.LoggingConfig" - }, - "SchemaHandlerPackage": { - "type": "string" - }, - "TypeName": { - "type": "string" - } - }, - "required": [ - "SchemaHandlerPackage", - "TypeName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::ResourceVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::ResourceVersion.LoggingConfig": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "type": "string" - }, - "LogRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudFormation::Stack": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "NotificationARNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Parameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TemplateURL": { - "type": "string" - }, - "TimeoutInMinutes": { - "type": "number" - } - }, - "required": [ - "TemplateURL" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::Stack" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::StackSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdministrationRoleARN": { - "type": "string" - }, - "AutoDeployment": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.AutoDeployment" - }, - "Capabilities": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "ExecutionRoleName": { - "type": "string" - }, - "OperationPreferences": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.OperationPreferences" - }, - "Parameters": { - "items": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.Parameter" - }, - "type": "array" - }, - "PermissionModel": { - "type": "string" - }, - "StackInstancesGroup": { - "items": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.StackInstances" - }, - "type": "array" - }, - "StackSetName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TemplateBody": { - "type": "string" - }, - "TemplateURL": { - "type": "string" - } - }, - "required": [ - "PermissionModel", - "StackSetName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::StackSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFormation::StackSet.AutoDeployment": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "RetainStacksOnAccountRemoval": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::CloudFormation::StackSet.DeploymentTargets": { - "additionalProperties": false, - "properties": { - "Accounts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OrganizationalUnitIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CloudFormation::StackSet.OperationPreferences": { - "additionalProperties": false, - "properties": { - "FailureToleranceCount": { - "type": "number" - }, - "FailureTolerancePercentage": { - "type": "number" - }, - "MaxConcurrentCount": { - "type": "number" - }, - "MaxConcurrentPercentage": { - "type": "number" - }, - "RegionOrder": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CloudFormation::StackSet.Parameter": { - "additionalProperties": false, - "properties": { - "ParameterKey": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterKey", - "ParameterValue" - ], - "type": "object" - }, - "AWS::CloudFormation::StackSet.StackInstances": { - "additionalProperties": false, - "properties": { - "DeploymentTargets": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.DeploymentTargets" - }, - "ParameterOverrides": { - "items": { - "$ref": "#/definitions/AWS::CloudFormation::StackSet.Parameter" - }, - "type": "array" - }, - "Regions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "DeploymentTargets", - "Regions" - ], - "type": "object" - }, - "AWS::CloudFormation::WaitCondition": { - "additionalProperties": false, - "properties": { - "CreationPolicy": { - "type": "object" - }, - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - }, - "Handle": { - "type": "string" - }, - "Timeout": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::WaitCondition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CloudFormation::WaitConditionHandle": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFormation::WaitConditionHandle" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CachePolicyConfig": { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy.CachePolicyConfig" - } - }, - "required": [ - "CachePolicyConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::CachePolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy.CachePolicyConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "DefaultTTL": { - "type": "number" - }, - "MaxTTL": { - "type": "number" - }, - "MinTTL": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "ParametersInCacheKeyAndForwardedToOrigin": { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy.ParametersInCacheKeyAndForwardedToOrigin" - } - }, - "required": [ - "DefaultTTL", - "MaxTTL", - "MinTTL", - "Name", - "ParametersInCacheKeyAndForwardedToOrigin" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy.CookiesConfig": { - "additionalProperties": false, - "properties": { - "CookieBehavior": { - "type": "string" - }, - "Cookies": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "CookieBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy.HeadersConfig": { - "additionalProperties": false, - "properties": { - "HeaderBehavior": { - "type": "string" - }, - "Headers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "HeaderBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy.ParametersInCacheKeyAndForwardedToOrigin": { - "additionalProperties": false, - "properties": { - "CookiesConfig": { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy.CookiesConfig" - }, - "EnableAcceptEncodingBrotli": { - "type": "boolean" - }, - "EnableAcceptEncodingGzip": { - "type": "boolean" - }, - "HeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy.HeadersConfig" - }, - "QueryStringsConfig": { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy.QueryStringsConfig" - } - }, - "required": [ - "CookiesConfig", - "EnableAcceptEncodingGzip", - "HeadersConfig", - "QueryStringsConfig" - ], - "type": "object" - }, - "AWS::CloudFront::CachePolicy.QueryStringsConfig": { - "additionalProperties": false, - "properties": { - "QueryStringBehavior": { - "type": "string" - }, - "QueryStrings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "QueryStringBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::CloudFrontOriginAccessIdentity": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CloudFrontOriginAccessIdentityConfig": { - "$ref": "#/definitions/AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig" - } - }, - "required": [ - "CloudFrontOriginAccessIdentityConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::CloudFrontOriginAccessIdentity" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - } - }, - "required": [ - "Comment" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DistributionConfig": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.DistributionConfig" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DistributionConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::Distribution" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.CacheBehavior": { - "additionalProperties": false, - "properties": { - "AllowedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CachePolicyId": { - "type": "string" - }, - "CachedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Compress": { - "type": "boolean" - }, - "DefaultTTL": { - "type": "number" - }, - "FieldLevelEncryptionId": { - "type": "string" - }, - "ForwardedValues": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.ForwardedValues" - }, - "LambdaFunctionAssociations": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.LambdaFunctionAssociation" - }, - "type": "array" - }, - "MaxTTL": { - "type": "number" - }, - "MinTTL": { - "type": "number" - }, - "OriginRequestPolicyId": { - "type": "string" - }, - "PathPattern": { - "type": "string" - }, - "RealtimeLogConfigArn": { - "type": "string" - }, - "SmoothStreaming": { - "type": "boolean" - }, - "TargetOriginId": { - "type": "string" - }, - "TrustedKeyGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TrustedSigners": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ViewerProtocolPolicy": { - "type": "string" - } - }, - "required": [ - "PathPattern", - "TargetOriginId", - "ViewerProtocolPolicy" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.Cookies": { - "additionalProperties": false, - "properties": { - "Forward": { - "type": "string" - }, - "WhitelistedNames": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Forward" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.CustomErrorResponse": { - "additionalProperties": false, - "properties": { - "ErrorCachingMinTTL": { - "type": "number" - }, - "ErrorCode": { - "type": "number" - }, - "ResponseCode": { - "type": "number" - }, - "ResponsePagePath": { - "type": "string" - } - }, - "required": [ - "ErrorCode" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.CustomOriginConfig": { - "additionalProperties": false, - "properties": { - "HTTPPort": { - "type": "number" - }, - "HTTPSPort": { - "type": "number" - }, - "OriginKeepaliveTimeout": { - "type": "number" - }, - "OriginProtocolPolicy": { - "type": "string" - }, - "OriginReadTimeout": { - "type": "number" - }, - "OriginSSLProtocols": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "OriginProtocolPolicy" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.DefaultCacheBehavior": { - "additionalProperties": false, - "properties": { - "AllowedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CachePolicyId": { - "type": "string" - }, - "CachedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Compress": { - "type": "boolean" - }, - "DefaultTTL": { - "type": "number" - }, - "FieldLevelEncryptionId": { - "type": "string" - }, - "ForwardedValues": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.ForwardedValues" - }, - "LambdaFunctionAssociations": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.LambdaFunctionAssociation" - }, - "type": "array" - }, - "MaxTTL": { - "type": "number" - }, - "MinTTL": { - "type": "number" - }, - "OriginRequestPolicyId": { - "type": "string" - }, - "RealtimeLogConfigArn": { - "type": "string" - }, - "SmoothStreaming": { - "type": "boolean" - }, - "TargetOriginId": { - "type": "string" - }, - "TrustedKeyGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TrustedSigners": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ViewerProtocolPolicy": { - "type": "string" - } - }, - "required": [ - "TargetOriginId", - "ViewerProtocolPolicy" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.DistributionConfig": { - "additionalProperties": false, - "properties": { - "Aliases": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CacheBehaviors": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.CacheBehavior" - }, - "type": "array" - }, - "Comment": { - "type": "string" - }, - "CustomErrorResponses": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.CustomErrorResponse" - }, - "type": "array" - }, - "DefaultCacheBehavior": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.DefaultCacheBehavior" - }, - "DefaultRootObject": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "HttpVersion": { - "type": "string" - }, - "IPV6Enabled": { - "type": "boolean" - }, - "Logging": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.Logging" - }, - "OriginGroups": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginGroups" - }, - "Origins": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.Origin" - }, - "type": "array" - }, - "PriceClass": { - "type": "string" - }, - "Restrictions": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.Restrictions" - }, - "ViewerCertificate": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.ViewerCertificate" - }, - "WebACLId": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.ForwardedValues": { - "additionalProperties": false, - "properties": { - "Cookies": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.Cookies" - }, - "Headers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "QueryString": { - "type": "boolean" - }, - "QueryStringCacheKeys": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "QueryString" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.GeoRestriction": { - "additionalProperties": false, - "properties": { - "Locations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RestrictionType": { - "type": "string" - } - }, - "required": [ - "RestrictionType" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.LambdaFunctionAssociation": { - "additionalProperties": false, - "properties": { - "EventType": { - "type": "string" - }, - "IncludeBody": { - "type": "boolean" - }, - "LambdaFunctionARN": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudFront::Distribution.Logging": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "IncludeCookies": { - "type": "boolean" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.Origin": { - "additionalProperties": false, - "properties": { - "ConnectionAttempts": { - "type": "number" - }, - "ConnectionTimeout": { - "type": "number" - }, - "CustomOriginConfig": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.CustomOriginConfig" - }, - "DomainName": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "OriginCustomHeaders": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginCustomHeader" - }, - "type": "array" - }, - "OriginPath": { - "type": "string" - }, - "OriginShield": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginShield" - }, - "S3OriginConfig": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.S3OriginConfig" - } - }, - "required": [ - "DomainName", - "Id" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginCustomHeader": { - "additionalProperties": false, - "properties": { - "HeaderName": { - "type": "string" - }, - "HeaderValue": { - "type": "string" - } - }, - "required": [ - "HeaderName", - "HeaderValue" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginGroup": { - "additionalProperties": false, - "properties": { - "FailoverCriteria": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginGroupFailoverCriteria" - }, - "Id": { - "type": "string" - }, - "Members": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginGroupMembers" - } - }, - "required": [ - "FailoverCriteria", - "Id", - "Members" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginGroupFailoverCriteria": { - "additionalProperties": false, - "properties": { - "StatusCodes": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.StatusCodes" - } - }, - "required": [ - "StatusCodes" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginGroupMember": { - "additionalProperties": false, - "properties": { - "OriginId": { - "type": "string" - } - }, - "required": [ - "OriginId" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginGroupMembers": { - "additionalProperties": false, - "properties": { - "Items": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginGroupMember" - }, - "type": "array" - }, - "Quantity": { - "type": "number" - } - }, - "required": [ - "Items", - "Quantity" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginGroups": { - "additionalProperties": false, - "properties": { - "Items": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.OriginGroup" - }, - "type": "array" - }, - "Quantity": { - "type": "number" - } - }, - "required": [ - "Quantity" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.OriginShield": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "OriginShieldRegion": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.Restrictions": { - "additionalProperties": false, - "properties": { - "GeoRestriction": { - "$ref": "#/definitions/AWS::CloudFront::Distribution.GeoRestriction" - } - }, - "required": [ - "GeoRestriction" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.S3OriginConfig": { - "additionalProperties": false, - "properties": { - "OriginAccessIdentity": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudFront::Distribution.StatusCodes": { - "additionalProperties": false, - "properties": { - "Items": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Quantity": { - "type": "number" - } - }, - "required": [ - "Items", - "Quantity" - ], - "type": "object" - }, - "AWS::CloudFront::Distribution.ViewerCertificate": { - "additionalProperties": false, - "properties": { - "AcmCertificateArn": { - "type": "string" - }, - "CloudFrontDefaultCertificate": { - "type": "boolean" - }, - "IamCertificateId": { - "type": "string" - }, - "MinimumProtocolVersion": { - "type": "string" - }, - "SslSupportMethod": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudFront::KeyGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "KeyGroupConfig": { - "$ref": "#/definitions/AWS::CloudFront::KeyGroup.KeyGroupConfig" - } - }, - "required": [ - "KeyGroupConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::KeyGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::KeyGroup.KeyGroupConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Items", - "Name" - ], - "type": "object" - }, - "AWS::CloudFront::OriginRequestPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "OriginRequestPolicyConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginRequestPolicy.OriginRequestPolicyConfig" - } - }, - "required": [ - "OriginRequestPolicyConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::OriginRequestPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::OriginRequestPolicy.CookiesConfig": { - "additionalProperties": false, - "properties": { - "CookieBehavior": { - "type": "string" - }, - "Cookies": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "CookieBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::OriginRequestPolicy.HeadersConfig": { - "additionalProperties": false, - "properties": { - "HeaderBehavior": { - "type": "string" - }, - "Headers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "HeaderBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::OriginRequestPolicy.OriginRequestPolicyConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "CookiesConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginRequestPolicy.CookiesConfig" - }, - "HeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginRequestPolicy.HeadersConfig" - }, - "Name": { - "type": "string" - }, - "QueryStringsConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginRequestPolicy.QueryStringsConfig" - } - }, - "required": [ - "CookiesConfig", - "HeadersConfig", - "Name", - "QueryStringsConfig" - ], - "type": "object" - }, - "AWS::CloudFront::OriginRequestPolicy.QueryStringsConfig": { - "additionalProperties": false, - "properties": { - "QueryStringBehavior": { - "type": "string" - }, - "QueryStrings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "QueryStringBehavior" - ], - "type": "object" - }, - "AWS::CloudFront::PublicKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PublicKeyConfig": { - "$ref": "#/definitions/AWS::CloudFront::PublicKey.PublicKeyConfig" - } - }, - "required": [ - "PublicKeyConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::PublicKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::PublicKey.PublicKeyConfig": { - "additionalProperties": false, - "properties": { - "CallerReference": { - "type": "string" - }, - "Comment": { - "type": "string" - }, - "EncodedKey": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "CallerReference", - "EncodedKey", - "Name" - ], - "type": "object" - }, - "AWS::CloudFront::RealtimeLogConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EndPoints": { - "items": { - "$ref": "#/definitions/AWS::CloudFront::RealtimeLogConfig.EndPoint" - }, - "type": "array" - }, - "Fields": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "SamplingRate": { - "type": "number" - } - }, - "required": [ - "EndPoints", - "Fields", - "Name", - "SamplingRate" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::RealtimeLogConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::RealtimeLogConfig.EndPoint": { - "additionalProperties": false, - "properties": { - "KinesisStreamConfig": { - "$ref": "#/definitions/AWS::CloudFront::RealtimeLogConfig.KinesisStreamConfig" - }, - "StreamType": { - "type": "string" - } - }, - "required": [ - "KinesisStreamConfig", - "StreamType" - ], - "type": "object" - }, - "AWS::CloudFront::RealtimeLogConfig.KinesisStreamConfig": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "StreamArn": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "StreamArn" - ], - "type": "object" - }, - "AWS::CloudFront::StreamingDistribution": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "StreamingDistributionConfig": { - "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "StreamingDistributionConfig", - "Tags" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudFront::StreamingDistribution" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudFront::StreamingDistribution.Logging": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Enabled", - "Prefix" - ], - "type": "object" - }, - "AWS::CloudFront::StreamingDistribution.S3Origin": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "OriginAccessIdentity": { - "type": "string" - } - }, - "required": [ - "DomainName", - "OriginAccessIdentity" - ], - "type": "object" - }, - "AWS::CloudFront::StreamingDistribution.StreamingDistributionConfig": { - "additionalProperties": false, - "properties": { - "Aliases": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Comment": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Logging": { - "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.Logging" - }, - "PriceClass": { - "type": "string" - }, - "S3Origin": { - "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.S3Origin" - }, - "TrustedSigners": { - "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.TrustedSigners" - } - }, - "required": [ - "Comment", - "Enabled", - "S3Origin", - "TrustedSigners" - ], - "type": "object" - }, - "AWS::CloudFront::StreamingDistribution.TrustedSigners": { - "additionalProperties": false, - "properties": { - "AwsAccountNumbers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::CloudTrail::Trail": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "CloudWatchLogsRoleArn": { - "type": "string" - }, - "EnableLogFileValidation": { - "type": "boolean" - }, - "EventSelectors": { - "items": { - "$ref": "#/definitions/AWS::CloudTrail::Trail.EventSelector" - }, - "type": "array" - }, - "IncludeGlobalServiceEvents": { - "type": "boolean" - }, - "IsLogging": { - "type": "boolean" - }, - "IsMultiRegionTrail": { - "type": "boolean" - }, - "KMSKeyId": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - }, - "SnsTopicName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TrailName": { - "type": "string" - } - }, - "required": [ - "IsLogging", - "S3BucketName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudTrail::Trail" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudTrail::Trail.DataResource": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CloudTrail::Trail.EventSelector": { - "additionalProperties": false, - "properties": { - "DataResources": { - "items": { - "$ref": "#/definitions/AWS::CloudTrail::Trail.DataResource" - }, - "type": "array" - }, - "IncludeManagementEvents": { - "type": "boolean" - }, - "ReadWriteType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudWatch::Alarm": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ActionsEnabled": { - "type": "boolean" - }, - "AlarmActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AlarmDescription": { - "type": "string" - }, - "AlarmName": { - "type": "string" - }, - "ComparisonOperator": { - "type": "string" - }, - "DatapointsToAlarm": { - "type": "number" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" - }, - "type": "array" - }, - "EvaluateLowSampleCountPercentile": { - "type": "string" - }, - "EvaluationPeriods": { - "type": "number" - }, - "ExtendedStatistic": { - "type": "string" - }, - "InsufficientDataActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Metrics": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::Alarm.MetricDataQuery" - }, - "type": "array" - }, - "Namespace": { - "type": "string" - }, - "OKActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Period": { - "type": "number" - }, - "Statistic": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "ThresholdMetricId": { - "type": "string" - }, - "TreatMissingData": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "EvaluationPeriods" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::Alarm" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::Alarm.Dimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::CloudWatch::Alarm.Metric": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudWatch::Alarm.MetricDataQuery": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Label": { - "type": "string" - }, - "MetricStat": { - "$ref": "#/definitions/AWS::CloudWatch::Alarm.MetricStat" - }, - "Period": { - "type": "number" - }, - "ReturnData": { - "type": "boolean" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "AWS::CloudWatch::Alarm.MetricStat": { - "additionalProperties": false, - "properties": { - "Metric": { - "$ref": "#/definitions/AWS::CloudWatch::Alarm.Metric" - }, - "Period": { - "type": "number" - }, - "Stat": { - "type": "string" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "Metric", - "Period", - "Stat" - ], - "type": "object" - }, - "AWS::CloudWatch::AnomalyDetector": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Configuration": { - "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Configuration" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Dimension" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Stat": { - "type": "string" - } - }, - "required": [ - "MetricName", - "Namespace", - "Stat" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::AnomalyDetector" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::AnomalyDetector.Configuration": { - "additionalProperties": false, - "properties": { - "ExcludedTimeRanges": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Range" - }, - "type": "array" - }, - "MetricTimeZone": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CloudWatch::AnomalyDetector.Dimension": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::CloudWatch::AnomalyDetector.Range": { - "additionalProperties": false, - "properties": { - "EndTime": { - "type": "string" - }, - "StartTime": { - "type": "string" - } - }, - "required": [ - "EndTime", - "StartTime" - ], - "type": "object" - }, - "AWS::CloudWatch::CompositeAlarm": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ActionsEnabled": { - "type": "boolean" - }, - "AlarmActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AlarmDescription": { - "type": "string" - }, - "AlarmName": { - "type": "string" - }, - "AlarmRule": { - "type": "string" - }, - "InsufficientDataActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OKActions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "AlarmName", - "AlarmRule" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::CompositeAlarm" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::Dashboard": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DashboardBody": { - "type": "string" - }, - "DashboardName": { - "type": "string" - } - }, - "required": [ - "DashboardBody" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::Dashboard" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::InsightRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RuleBody": { - "type": "string" - }, - "RuleName": { - "type": "string" - }, - "RuleState": { - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/AWS::CloudWatch::InsightRule.Tags" - } - }, - "required": [ - "RuleBody", - "RuleName", - "RuleState" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::InsightRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::InsightRule.Tags": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::CloudWatch::MetricStream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExcludeFilters": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamFilter" - }, - "type": "array" - }, - "FirehoseArn": { - "type": "string" - }, - "IncludeFilters": { - "items": { - "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamFilter" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "OutputFormat": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "FirehoseArn", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CloudWatch::MetricStream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CloudWatch::MetricStream.MetricStreamFilter": { - "additionalProperties": false, - "properties": { - "Namespace": { - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "AWS::CodeArtifact::Domain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "EncryptionKey": { - "type": "string" - }, - "PermissionsPolicyDocument": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DomainName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeArtifact::Domain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeArtifact::Repository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "DomainOwner": { - "type": "string" - }, - "ExternalConnections": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PermissionsPolicyDocument": { - "type": "object" - }, - "RepositoryName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Upstreams": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "DomainName", - "RepositoryName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeArtifact::Repository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeBuild::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Artifacts": { - "$ref": "#/definitions/AWS::CodeBuild::Project.Artifacts" - }, - "BadgeEnabled": { - "type": "boolean" - }, - "BuildBatchConfig": { - "$ref": "#/definitions/AWS::CodeBuild::Project.ProjectBuildBatchConfig" - }, - "Cache": { - "$ref": "#/definitions/AWS::CodeBuild::Project.ProjectCache" - }, - "ConcurrentBuildLimit": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "EncryptionKey": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::CodeBuild::Project.Environment" - }, - "FileSystemLocations": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.ProjectFileSystemLocation" - }, - "type": "array" - }, - "LogsConfig": { - "$ref": "#/definitions/AWS::CodeBuild::Project.LogsConfig" - }, - "Name": { - "type": "string" - }, - "QueuedTimeoutInMinutes": { - "type": "number" - }, - "SecondaryArtifacts": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.Artifacts" - }, - "type": "array" - }, - "SecondarySourceVersions": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.ProjectSourceVersion" - }, - "type": "array" - }, - "SecondarySources": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.Source" - }, - "type": "array" - }, - "ServiceRole": { - "type": "string" - }, - "Source": { - "$ref": "#/definitions/AWS::CodeBuild::Project.Source" - }, - "SourceVersion": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TimeoutInMinutes": { - "type": "number" - }, - "Triggers": { - "$ref": "#/definitions/AWS::CodeBuild::Project.ProjectTriggers" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::CodeBuild::Project.VpcConfig" - } - }, - "required": [ - "Artifacts", - "Environment", - "ServiceRole", - "Source" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeBuild::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.Artifacts": { - "additionalProperties": false, - "properties": { - "ArtifactIdentifier": { - "type": "string" - }, - "EncryptionDisabled": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NamespaceType": { - "type": "string" - }, - "OverrideArtifactName": { - "type": "boolean" - }, - "Packaging": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.BatchRestrictions": { - "additionalProperties": false, - "properties": { - "ComputeTypesAllowed": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaximumBuildsAllowed": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.BuildStatusConfig": { - "additionalProperties": false, - "properties": { - "Context": { - "type": "string" - }, - "TargetUrl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.CloudWatchLogsConfig": { - "additionalProperties": false, - "properties": { - "GroupName": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "StreamName": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.Environment": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "ComputeType": { - "type": "string" - }, - "EnvironmentVariables": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.EnvironmentVariable" - }, - "type": "array" - }, - "Image": { - "type": "string" - }, - "ImagePullCredentialsType": { - "type": "string" - }, - "PrivilegedMode": { - "type": "boolean" - }, - "RegistryCredential": { - "$ref": "#/definitions/AWS::CodeBuild::Project.RegistryCredential" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ComputeType", - "Image", - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.FilterGroup": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::CodeBuild::Project.GitSubmodulesConfig": { - "additionalProperties": false, - "properties": { - "FetchSubmodules": { - "type": "boolean" - } - }, - "required": [ - "FetchSubmodules" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.LogsConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/AWS::CodeBuild::Project.CloudWatchLogsConfig" - }, - "S3Logs": { - "$ref": "#/definitions/AWS::CodeBuild::Project.S3LogsConfig" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.ProjectBuildBatchConfig": { - "additionalProperties": false, - "properties": { - "CombineArtifacts": { - "type": "boolean" - }, - "Restrictions": { - "$ref": "#/definitions/AWS::CodeBuild::Project.BatchRestrictions" - }, - "ServiceRole": { - "type": "string" - }, - "TimeoutInMins": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.ProjectCache": { - "additionalProperties": false, - "properties": { - "Location": { - "type": "string" - }, - "Modes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.ProjectFileSystemLocation": { - "additionalProperties": false, - "properties": { - "Identifier": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "MountOptions": { - "type": "string" - }, - "MountPoint": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Identifier", - "Location", - "MountPoint", - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.ProjectSourceVersion": { - "additionalProperties": false, - "properties": { - "SourceIdentifier": { - "type": "string" - }, - "SourceVersion": { - "type": "string" - } - }, - "required": [ - "SourceIdentifier" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.ProjectTriggers": { - "additionalProperties": false, - "properties": { - "BuildType": { - "type": "string" - }, - "FilterGroups": { - "items": { - "$ref": "#/definitions/AWS::CodeBuild::Project.FilterGroup" - }, - "type": "array" - }, - "Webhook": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.RegistryCredential": { - "additionalProperties": false, - "properties": { - "Credential": { - "type": "string" - }, - "CredentialProvider": { - "type": "string" - } - }, - "required": [ - "Credential", - "CredentialProvider" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.S3LogsConfig": { - "additionalProperties": false, - "properties": { - "EncryptionDisabled": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.Source": { - "additionalProperties": false, - "properties": { - "Auth": { - "$ref": "#/definitions/AWS::CodeBuild::Project.SourceAuth" - }, - "BuildSpec": { - "type": "string" - }, - "BuildStatusConfig": { - "$ref": "#/definitions/AWS::CodeBuild::Project.BuildStatusConfig" - }, - "GitCloneDepth": { - "type": "number" - }, - "GitSubmodulesConfig": { - "$ref": "#/definitions/AWS::CodeBuild::Project.GitSubmodulesConfig" - }, - "InsecureSsl": { - "type": "boolean" - }, - "Location": { - "type": "string" - }, - "ReportBuildStatus": { - "type": "boolean" - }, - "SourceIdentifier": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.SourceAuth": { - "additionalProperties": false, - "properties": { - "Resource": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::Project.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeBuild::Project.WebhookFilter": { - "additionalProperties": false, - "properties": { - "ExcludeMatchedPattern": { - "type": "boolean" - }, - "Pattern": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Pattern", - "Type" - ], - "type": "object" - }, - "AWS::CodeBuild::ReportGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeleteReports": { - "type": "boolean" - }, - "ExportConfig": { - "$ref": "#/definitions/AWS::CodeBuild::ReportGroup.ReportExportConfig" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ExportConfig", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeBuild::ReportGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeBuild::ReportGroup.ReportExportConfig": { - "additionalProperties": false, - "properties": { - "ExportConfigType": { - "type": "string" - }, - "S3Destination": { - "$ref": "#/definitions/AWS::CodeBuild::ReportGroup.S3ReportExportConfig" - } - }, - "required": [ - "ExportConfigType" - ], - "type": "object" - }, - "AWS::CodeBuild::ReportGroup.S3ReportExportConfig": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "BucketOwner": { - "type": "string" - }, - "EncryptionDisabled": { - "type": "boolean" - }, - "EncryptionKey": { - "type": "string" - }, - "Packaging": { - "type": "string" - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "AWS::CodeBuild::SourceCredential": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthType": { - "type": "string" - }, - "ServerType": { - "type": "string" - }, - "Token": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "AuthType", - "ServerType", - "Token" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeBuild::SourceCredential" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeCommit::Repository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Code": { - "$ref": "#/definitions/AWS::CodeCommit::Repository.Code" - }, - "RepositoryDescription": { - "type": "string" - }, - "RepositoryName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Triggers": { - "items": { - "$ref": "#/definitions/AWS::CodeCommit::Repository.RepositoryTrigger" - }, - "type": "array" - } - }, - "required": [ - "RepositoryName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeCommit::Repository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeCommit::Repository.Code": { - "additionalProperties": false, - "properties": { - "BranchName": { - "type": "string" - }, - "S3": { - "$ref": "#/definitions/AWS::CodeCommit::Repository.S3" - } - }, - "required": [ - "S3" - ], - "type": "object" - }, - "AWS::CodeCommit::Repository.RepositoryTrigger": { - "additionalProperties": false, - "properties": { - "Branches": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CustomData": { - "type": "string" - }, - "DestinationArn": { - "type": "string" - }, - "Events": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DestinationArn", - "Events", - "Name" - ], - "type": "object" - }, - "AWS::CodeCommit::Repository.S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::CodeDeploy::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "ComputePlatform": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeDeploy::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeploymentConfigName": { - "type": "string" - }, - "MinimumHealthyHosts": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeDeploy::DeploymentConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AlarmConfiguration": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration" - }, - "ApplicationName": { - "type": "string" - }, - "AutoRollbackConfiguration": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration" - }, - "AutoScalingGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Deployment": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.Deployment" - }, - "DeploymentConfigName": { - "type": "string" - }, - "DeploymentGroupName": { - "type": "string" - }, - "DeploymentStyle": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.DeploymentStyle" - }, - "Ec2TagFilters": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.EC2TagFilter" - }, - "type": "array" - }, - "Ec2TagSet": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.EC2TagSet" - }, - "LoadBalancerInfo": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo" - }, - "OnPremisesInstanceTagFilters": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TagFilter" - }, - "type": "array" - }, - "OnPremisesTagSet": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet" - }, - "ServiceRoleArn": { - "type": "string" - }, - "TriggerConfigurations": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TriggerConfig" - }, - "type": "array" - } - }, - "required": [ - "ApplicationName", - "ServiceRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeDeploy::DeploymentGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.Alarm": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.AlarmConfiguration": { - "additionalProperties": false, - "properties": { - "Alarms": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.Alarm" - }, - "type": "array" - }, - "Enabled": { - "type": "boolean" - }, - "IgnorePollAlarmFailure": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.AutoRollbackConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Events": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.Deployment": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "IgnoreApplicationStopFailures": { - "type": "boolean" - }, - "Revision": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.RevisionLocation" - } - }, - "required": [ - "Revision" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.DeploymentStyle": { - "additionalProperties": false, - "properties": { - "DeploymentOption": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.EC2TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.EC2TagSet": { - "additionalProperties": false, - "properties": { - "Ec2TagSetList": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.EC2TagSetListObject": { - "additionalProperties": false, - "properties": { - "Ec2TagGroup": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.EC2TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.ELBInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.GitHubLocation": { - "additionalProperties": false, - "properties": { - "CommitId": { - "type": "string" - }, - "Repository": { - "type": "string" - } - }, - "required": [ - "CommitId", - "Repository" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.LoadBalancerInfo": { - "additionalProperties": false, - "properties": { - "ElbInfoList": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.ELBInfo" - }, - "type": "array" - }, - "TargetGroupInfoList": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSet": { - "additionalProperties": false, - "properties": { - "OnPremisesTagSetList": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.OnPremisesTagSetListObject": { - "additionalProperties": false, - "properties": { - "OnPremisesTagGroup": { - "items": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.RevisionLocation": { - "additionalProperties": false, - "properties": { - "GitHubLocation": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.GitHubLocation" - }, - "RevisionType": { - "type": "string" - }, - "S3Location": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.S3Location" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "BundleType": { - "type": "string" - }, - "ETag": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeDeploy::DeploymentGroup.TriggerConfig": { - "additionalProperties": false, - "properties": { - "TriggerEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TriggerName": { - "type": "string" - }, - "TriggerTargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodeGuruProfiler::ProfilingGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AgentPermissions": { - "type": "object" - }, - "AnomalyDetectionNotificationConfiguration": { - "items": { - "$ref": "#/definitions/AWS::CodeGuruProfiler::ProfilingGroup.Channel" - }, - "type": "array" - }, - "ComputePlatform": { - "type": "string" - }, - "ProfilingGroupName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ProfilingGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeGuruProfiler::ProfilingGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeGuruProfiler::ProfilingGroup.Channel": { - "additionalProperties": false, - "properties": { - "channelId": { - "type": "string" - }, - "channelUri": { - "type": "string" - } - }, - "required": [ - "channelUri" - ], - "type": "object" - }, - "AWS::CodeGuruReviewer::RepositoryAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeGuruReviewer::RepositoryAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodePipeline::CustomActionType": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Category": { - "type": "string" - }, - "ConfigurationProperties": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::CustomActionType.ConfigurationProperties" - }, - "type": "array" - }, - "InputArtifactDetails": { - "$ref": "#/definitions/AWS::CodePipeline::CustomActionType.ArtifactDetails" - }, - "OutputArtifactDetails": { - "$ref": "#/definitions/AWS::CodePipeline::CustomActionType.ArtifactDetails" - }, - "Provider": { - "type": "string" - }, - "Settings": { - "$ref": "#/definitions/AWS::CodePipeline::CustomActionType.Settings" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Category", - "InputArtifactDetails", - "OutputArtifactDetails", - "Provider", - "Version" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodePipeline::CustomActionType" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodePipeline::CustomActionType.ArtifactDetails": { - "additionalProperties": false, - "properties": { - "MaximumCount": { - "type": "number" - }, - "MinimumCount": { - "type": "number" - } - }, - "required": [ - "MaximumCount", - "MinimumCount" - ], - "type": "object" - }, - "AWS::CodePipeline::CustomActionType.ConfigurationProperties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Key": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Queryable": { - "type": "boolean" - }, - "Required": { - "type": "boolean" - }, - "Secret": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Key", - "Name", - "Required", - "Secret" - ], - "type": "object" - }, - "AWS::CodePipeline::CustomActionType.Settings": { - "additionalProperties": false, - "properties": { - "EntityUrlTemplate": { - "type": "string" - }, - "ExecutionUrlTemplate": { - "type": "string" - }, - "RevisionUrlTemplate": { - "type": "string" - }, - "ThirdPartyConfigurationUrl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodePipeline::Pipeline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ArtifactStore": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.ArtifactStore" - }, - "ArtifactStores": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.ArtifactStoreMap" - }, - "type": "array" - }, - "DisableInboundStageTransitions": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.StageTransition" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "RestartExecutionOnUpdate": { - "type": "boolean" - }, - "RoleArn": { - "type": "string" - }, - "Stages": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.StageDeclaration" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "RoleArn", - "Stages" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodePipeline::Pipeline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.ActionDeclaration": { - "additionalProperties": false, - "properties": { - "ActionTypeId": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.ActionTypeId" - }, - "Configuration": { - "type": "object" - }, - "InputArtifacts": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.InputArtifact" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "OutputArtifacts": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.OutputArtifact" - }, - "type": "array" - }, - "Region": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "RunOrder": { - "type": "number" - } - }, - "required": [ - "ActionTypeId", - "Name" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.ActionTypeId": { - "additionalProperties": false, - "properties": { - "Category": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "Provider": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Category", - "Owner", - "Provider", - "Version" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.ArtifactStore": { - "additionalProperties": false, - "properties": { - "EncryptionKey": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.EncryptionKey" - }, - "Location": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Location", - "Type" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.ArtifactStoreMap": { - "additionalProperties": false, - "properties": { - "ArtifactStore": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.ArtifactStore" - }, - "Region": { - "type": "string" - } - }, - "required": [ - "ArtifactStore", - "Region" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.BlockerDeclaration": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.EncryptionKey": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Id", - "Type" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.InputArtifact": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.OutputArtifact": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.StageDeclaration": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.ActionDeclaration" - }, - "type": "array" - }, - "Blockers": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline.BlockerDeclaration" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Actions", - "Name" - ], - "type": "object" - }, - "AWS::CodePipeline::Pipeline.StageTransition": { - "additionalProperties": false, - "properties": { - "Reason": { - "type": "string" - }, - "StageName": { - "type": "string" - } - }, - "required": [ - "Reason", - "StageName" - ], - "type": "object" - }, - "AWS::CodePipeline::Webhook": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Authentication": { - "type": "string" - }, - "AuthenticationConfiguration": { - "$ref": "#/definitions/AWS::CodePipeline::Webhook.WebhookAuthConfiguration" - }, - "Filters": { - "items": { - "$ref": "#/definitions/AWS::CodePipeline::Webhook.WebhookFilterRule" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "RegisterWithThirdParty": { - "type": "boolean" - }, - "TargetAction": { - "type": "string" - }, - "TargetPipeline": { - "type": "string" - }, - "TargetPipelineVersion": { - "type": "number" - } - }, - "required": [ - "Authentication", - "AuthenticationConfiguration", - "Filters", - "TargetAction", - "TargetPipeline", - "TargetPipelineVersion" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodePipeline::Webhook" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodePipeline::Webhook.WebhookAuthConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedIPRange": { - "type": "string" - }, - "SecretToken": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::CodePipeline::Webhook.WebhookFilterRule": { - "additionalProperties": false, - "properties": { - "JsonPath": { - "type": "string" - }, - "MatchEquals": { - "type": "string" - } - }, - "required": [ - "JsonPath" - ], - "type": "object" - }, - "AWS::CodeStar::GitHubRepository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Code": { - "$ref": "#/definitions/AWS::CodeStar::GitHubRepository.Code" - }, - "ConnectionArn": { - "type": "string" - }, - "EnableIssues": { - "type": "boolean" - }, - "IsPrivate": { - "type": "boolean" - }, - "RepositoryAccessToken": { - "type": "string" - }, - "RepositoryDescription": { - "type": "string" - }, - "RepositoryName": { - "type": "string" - }, - "RepositoryOwner": { - "type": "string" - } - }, - "required": [ - "RepositoryName", - "RepositoryOwner" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeStar::GitHubRepository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeStar::GitHubRepository.Code": { - "additionalProperties": false, - "properties": { - "S3": { - "$ref": "#/definitions/AWS::CodeStar::GitHubRepository.S3" - } - }, - "required": [ - "S3" - ], - "type": "object" - }, - "AWS::CodeStar::GitHubRepository.S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::CodeStarConnections::Connection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "HostArn": { - "type": "string" - }, - "ProviderType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ConnectionName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeStarConnections::Connection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeStarNotifications::NotificationRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DetailType": { - "type": "string" - }, - "EventTypeIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Resource": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::CodeStarNotifications::NotificationRule.Target" - }, - "type": "array" - } - }, - "required": [ - "DetailType", - "EventTypeIds", - "Name", - "Resource", - "Targets" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::CodeStarNotifications::NotificationRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::CodeStarNotifications::NotificationRule.Target": { - "additionalProperties": false, - "properties": { - "TargetAddress": { - "type": "string" - }, - "TargetType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::IdentityPool": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowClassicFlow": { - "type": "boolean" - }, - "AllowUnauthenticatedIdentities": { - "type": "boolean" - }, - "CognitoEvents": { - "type": "object" - }, - "CognitoIdentityProviders": { - "items": { - "$ref": "#/definitions/AWS::Cognito::IdentityPool.CognitoIdentityProvider" - }, - "type": "array" - }, - "CognitoStreams": { - "$ref": "#/definitions/AWS::Cognito::IdentityPool.CognitoStreams" - }, - "DeveloperProviderName": { - "type": "string" - }, - "IdentityPoolName": { - "type": "string" - }, - "OpenIdConnectProviderARNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PushSync": { - "$ref": "#/definitions/AWS::Cognito::IdentityPool.PushSync" - }, - "SamlProviderARNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SupportedLoginProviders": { - "type": "object" - } - }, - "required": [ - "AllowUnauthenticatedIdentities" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::IdentityPool" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::IdentityPool.CognitoIdentityProvider": { - "additionalProperties": false, - "properties": { - "ClientId": { - "type": "string" - }, - "ProviderName": { - "type": "string" - }, - "ServerSideTokenCheck": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Cognito::IdentityPool.CognitoStreams": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "StreamName": { - "type": "string" - }, - "StreamingStatus": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::IdentityPool.PushSync": { - "additionalProperties": false, - "properties": { - "ApplicationArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::IdentityPoolRoleAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "IdentityPoolId": { - "type": "string" - }, - "RoleMappings": { - "type": "object" - }, - "Roles": { - "type": "object" - } - }, - "required": [ - "IdentityPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::IdentityPoolRoleAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::IdentityPoolRoleAttachment.MappingRule": { - "additionalProperties": false, - "properties": { - "Claim": { - "type": "string" - }, - "MatchType": { - "type": "string" - }, - "RoleARN": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Claim", - "MatchType", - "RoleARN", - "Value" - ], - "type": "object" - }, - "AWS::Cognito::IdentityPoolRoleAttachment.RoleMapping": { - "additionalProperties": false, - "properties": { - "AmbiguousRoleResolution": { - "type": "string" - }, - "IdentityProvider": { - "type": "string" - }, - "RulesConfiguration": { - "$ref": "#/definitions/AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Cognito::IdentityPoolRoleAttachment.RulesConfigurationType": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::Cognito::IdentityPoolRoleAttachment.MappingRule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::Cognito::UserPool": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccountRecoverySetting": { - "$ref": "#/definitions/AWS::Cognito::UserPool.AccountRecoverySetting" - }, - "AdminCreateUserConfig": { - "$ref": "#/definitions/AWS::Cognito::UserPool.AdminCreateUserConfig" - }, - "AliasAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AutoVerifiedAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DeviceConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPool.DeviceConfiguration" - }, - "EmailConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPool.EmailConfiguration" - }, - "EmailVerificationMessage": { - "type": "string" - }, - "EmailVerificationSubject": { - "type": "string" - }, - "EnabledMfas": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LambdaConfig": { - "$ref": "#/definitions/AWS::Cognito::UserPool.LambdaConfig" - }, - "MfaConfiguration": { - "type": "string" - }, - "Policies": { - "$ref": "#/definitions/AWS::Cognito::UserPool.Policies" - }, - "Schema": { - "items": { - "$ref": "#/definitions/AWS::Cognito::UserPool.SchemaAttribute" - }, - "type": "array" - }, - "SmsAuthenticationMessage": { - "type": "string" - }, - "SmsConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPool.SmsConfiguration" - }, - "SmsVerificationMessage": { - "type": "string" - }, - "UserPoolAddOns": { - "$ref": "#/definitions/AWS::Cognito::UserPool.UserPoolAddOns" - }, - "UserPoolName": { - "type": "string" - }, - "UserPoolTags": { - "type": "object" - }, - "UsernameAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UsernameConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPool.UsernameConfiguration" - }, - "VerificationMessageTemplate": { - "$ref": "#/definitions/AWS::Cognito::UserPool.VerificationMessageTemplate" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPool" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Cognito::UserPool.AccountRecoverySetting": { - "additionalProperties": false, - "properties": { - "RecoveryMechanisms": { - "items": { - "$ref": "#/definitions/AWS::Cognito::UserPool.RecoveryOption" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.AdminCreateUserConfig": { - "additionalProperties": false, - "properties": { - "AllowAdminCreateUserOnly": { - "type": "boolean" - }, - "InviteMessageTemplate": { - "$ref": "#/definitions/AWS::Cognito::UserPool.InviteMessageTemplate" - }, - "UnusedAccountValidityDays": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.CustomEmailSender": { - "additionalProperties": false, - "properties": { - "LambdaArn": { - "type": "string" - }, - "LambdaVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.CustomSMSSender": { - "additionalProperties": false, - "properties": { - "LambdaArn": { - "type": "string" - }, - "LambdaVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.DeviceConfiguration": { - "additionalProperties": false, - "properties": { - "ChallengeRequiredOnNewDevice": { - "type": "boolean" - }, - "DeviceOnlyRememberedOnUserPrompt": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.EmailConfiguration": { - "additionalProperties": false, - "properties": { - "ConfigurationSet": { - "type": "string" - }, - "EmailSendingAccount": { - "type": "string" - }, - "From": { - "type": "string" - }, - "ReplyToEmailAddress": { - "type": "string" - }, - "SourceArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.InviteMessageTemplate": { - "additionalProperties": false, - "properties": { - "EmailMessage": { - "type": "string" - }, - "EmailSubject": { - "type": "string" - }, - "SMSMessage": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.LambdaConfig": { - "additionalProperties": false, - "properties": { - "CreateAuthChallenge": { - "type": "string" - }, - "CustomEmailSender": { - "$ref": "#/definitions/AWS::Cognito::UserPool.CustomEmailSender" - }, - "CustomMessage": { - "type": "string" - }, - "CustomSMSSender": { - "$ref": "#/definitions/AWS::Cognito::UserPool.CustomSMSSender" - }, - "DefineAuthChallenge": { - "type": "string" - }, - "KMSKeyID": { - "type": "string" - }, - "PostAuthentication": { - "type": "string" - }, - "PostConfirmation": { - "type": "string" - }, - "PreAuthentication": { - "type": "string" - }, - "PreSignUp": { - "type": "string" - }, - "PreTokenGeneration": { - "type": "string" - }, - "UserMigration": { - "type": "string" - }, - "VerifyAuthChallengeResponse": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.NumberAttributeConstraints": { - "additionalProperties": false, - "properties": { - "MaxValue": { - "type": "string" - }, - "MinValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.PasswordPolicy": { - "additionalProperties": false, - "properties": { - "MinimumLength": { - "type": "number" - }, - "RequireLowercase": { - "type": "boolean" - }, - "RequireNumbers": { - "type": "boolean" - }, - "RequireSymbols": { - "type": "boolean" - }, - "RequireUppercase": { - "type": "boolean" - }, - "TemporaryPasswordValidityDays": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.Policies": { - "additionalProperties": false, - "properties": { - "PasswordPolicy": { - "$ref": "#/definitions/AWS::Cognito::UserPool.PasswordPolicy" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.RecoveryOption": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Priority": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.SchemaAttribute": { - "additionalProperties": false, - "properties": { - "AttributeDataType": { - "type": "string" - }, - "DeveloperOnlyAttribute": { - "type": "boolean" - }, - "Mutable": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "NumberAttributeConstraints": { - "$ref": "#/definitions/AWS::Cognito::UserPool.NumberAttributeConstraints" - }, - "Required": { - "type": "boolean" - }, - "StringAttributeConstraints": { - "$ref": "#/definitions/AWS::Cognito::UserPool.StringAttributeConstraints" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.SmsConfiguration": { - "additionalProperties": false, - "properties": { - "ExternalId": { - "type": "string" - }, - "SnsCallerArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.StringAttributeConstraints": { - "additionalProperties": false, - "properties": { - "MaxLength": { - "type": "string" - }, - "MinLength": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.UserPoolAddOns": { - "additionalProperties": false, - "properties": { - "AdvancedSecurityMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.UsernameConfiguration": { - "additionalProperties": false, - "properties": { - "CaseSensitive": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPool.VerificationMessageTemplate": { - "additionalProperties": false, - "properties": { - "DefaultEmailOption": { - "type": "string" - }, - "EmailMessage": { - "type": "string" - }, - "EmailMessageByLink": { - "type": "string" - }, - "EmailSubject": { - "type": "string" - }, - "EmailSubjectByLink": { - "type": "string" - }, - "SmsMessage": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolClient": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessTokenValidity": { - "type": "number" - }, - "AllowedOAuthFlows": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedOAuthFlowsUserPoolClient": { - "type": "boolean" - }, - "AllowedOAuthScopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AnalyticsConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPoolClient.AnalyticsConfiguration" - }, - "CallbackURLs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClientName": { - "type": "string" - }, - "DefaultRedirectURI": { - "type": "string" - }, - "ExplicitAuthFlows": { - "items": { - "type": "string" - }, - "type": "array" - }, - "GenerateSecret": { - "type": "boolean" - }, - "IdTokenValidity": { - "type": "number" - }, - "LogoutURLs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PreventUserExistenceErrors": { - "type": "string" - }, - "ReadAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RefreshTokenValidity": { - "type": "number" - }, - "SupportedIdentityProviders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TokenValidityUnits": { - "$ref": "#/definitions/AWS::Cognito::UserPoolClient.TokenValidityUnits" - }, - "UserPoolId": { - "type": "string" - }, - "WriteAttributes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolClient" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolClient.AnalyticsConfiguration": { - "additionalProperties": false, - "properties": { - "ApplicationArn": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "ExternalId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UserDataShared": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolClient.TokenValidityUnits": { - "additionalProperties": false, - "properties": { - "AccessToken": { - "type": "string" - }, - "IdToken": { - "type": "string" - }, - "RefreshToken": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolDomain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CustomDomainConfig": { - "$ref": "#/definitions/AWS::Cognito::UserPoolDomain.CustomDomainConfigType" - }, - "Domain": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "Domain", - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolDomain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolDomain.CustomDomainConfigType": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "Precedence": { - "type": "number" - }, - "RoleArn": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolIdentityProvider": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AttributeMapping": { - "type": "object" - }, - "IdpIdentifiers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ProviderDetails": { - "type": "object" - }, - "ProviderName": { - "type": "string" - }, - "ProviderType": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "ProviderName", - "ProviderType", - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolIdentityProvider" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolResourceServer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Identifier": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Scopes": { - "items": { - "$ref": "#/definitions/AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType" - }, - "type": "array" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "Identifier", - "Name", - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolResourceServer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolResourceServer.ResourceServerScopeType": { - "additionalProperties": false, - "properties": { - "ScopeDescription": { - "type": "string" - }, - "ScopeName": { - "type": "string" - } - }, - "required": [ - "ScopeDescription", - "ScopeName" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccountTakeoverRiskConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType" - }, - "ClientId": { - "type": "string" - }, - "CompromisedCredentialsRiskConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType" - }, - "RiskExceptionConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "ClientId", - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolRiskConfigurationAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType": { - "additionalProperties": false, - "properties": { - "EventAction": { - "type": "string" - }, - "Notify": { - "type": "boolean" - } - }, - "required": [ - "EventAction", - "Notify" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType": { - "additionalProperties": false, - "properties": { - "HighAction": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType" - }, - "LowAction": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType" - }, - "MediumAction": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionType" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverRiskConfigurationType": { - "additionalProperties": false, - "properties": { - "Actions": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.AccountTakeoverActionsType" - }, - "NotifyConfiguration": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType" - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType": { - "additionalProperties": false, - "properties": { - "EventAction": { - "type": "string" - } - }, - "required": [ - "EventAction" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsRiskConfigurationType": { - "additionalProperties": false, - "properties": { - "Actions": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.CompromisedCredentialsActionsType" - }, - "EventFilter": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyConfigurationType": { - "additionalProperties": false, - "properties": { - "BlockEmail": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType" - }, - "From": { - "type": "string" - }, - "MfaEmail": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType" - }, - "NoActionEmail": { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType" - }, - "ReplyTo": { - "type": "string" - }, - "SourceArn": { - "type": "string" - } - }, - "required": [ - "SourceArn" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.NotifyEmailType": { - "additionalProperties": false, - "properties": { - "HtmlBody": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "TextBody": { - "type": "string" - } - }, - "required": [ - "Subject" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolRiskConfigurationAttachment.RiskExceptionConfigurationType": { - "additionalProperties": false, - "properties": { - "BlockedIPRangeList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SkippedIPRangeList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolUICustomizationAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CSS": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "required": [ - "ClientId", - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolUICustomizationAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolUser": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClientMetadata": { - "type": "object" - }, - "DesiredDeliveryMediums": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ForceAliasCreation": { - "type": "boolean" - }, - "MessageAction": { - "type": "string" - }, - "UserAttributes": { - "items": { - "$ref": "#/definitions/AWS::Cognito::UserPoolUser.AttributeType" - }, - "type": "array" - }, - "UserPoolId": { - "type": "string" - }, - "Username": { - "type": "string" - }, - "ValidationData": { - "items": { - "$ref": "#/definitions/AWS::Cognito::UserPoolUser.AttributeType" - }, - "type": "array" - } - }, - "required": [ - "UserPoolId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolUser" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Cognito::UserPoolUser.AttributeType": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Cognito::UserPoolUserToGroupAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupName": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "GroupName", - "UserPoolId", - "Username" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Cognito::UserPoolUserToGroupAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::AggregationAuthorization": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthorizedAccountId": { - "type": "string" - }, - "AuthorizedAwsRegion": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AuthorizedAccountId", - "AuthorizedAwsRegion" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::AggregationAuthorization" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::ConfigRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConfigRuleName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "object" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "Scope": { - "$ref": "#/definitions/AWS::Config::ConfigRule.Scope" - }, - "Source": { - "$ref": "#/definitions/AWS::Config::ConfigRule.Source" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::ConfigRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::ConfigRule.Scope": { - "additionalProperties": false, - "properties": { - "ComplianceResourceId": { - "type": "string" - }, - "ComplianceResourceTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TagKey": { - "type": "string" - }, - "TagValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Config::ConfigRule.Source": { - "additionalProperties": false, - "properties": { - "Owner": { - "type": "string" - }, - "SourceDetails": { - "items": { - "$ref": "#/definitions/AWS::Config::ConfigRule.SourceDetail" - }, - "type": "array" - }, - "SourceIdentifier": { - "type": "string" - } - }, - "required": [ - "Owner", - "SourceIdentifier" - ], - "type": "object" - }, - "AWS::Config::ConfigRule.SourceDetail": { - "additionalProperties": false, - "properties": { - "EventSource": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "MessageType": { - "type": "string" - } - }, - "required": [ - "EventSource", - "MessageType" - ], - "type": "object" - }, - "AWS::Config::ConfigurationAggregator": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccountAggregationSources": { - "items": { - "$ref": "#/definitions/AWS::Config::ConfigurationAggregator.AccountAggregationSource" - }, - "type": "array" - }, - "ConfigurationAggregatorName": { - "type": "string" - }, - "OrganizationAggregationSource": { - "$ref": "#/definitions/AWS::Config::ConfigurationAggregator.OrganizationAggregationSource" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ConfigurationAggregatorName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::ConfigurationAggregator" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::ConfigurationAggregator.AccountAggregationSource": { - "additionalProperties": false, - "properties": { - "AccountIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllAwsRegions": { - "type": "boolean" - }, - "AwsRegions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "AccountIds" - ], - "type": "object" - }, - "AWS::Config::ConfigurationAggregator.OrganizationAggregationSource": { - "additionalProperties": false, - "properties": { - "AllAwsRegions": { - "type": "boolean" - }, - "AwsRegions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "AWS::Config::ConfigurationRecorder": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RecordingGroup": { - "$ref": "#/definitions/AWS::Config::ConfigurationRecorder.RecordingGroup" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "RoleARN" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::ConfigurationRecorder" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::ConfigurationRecorder.RecordingGroup": { - "additionalProperties": false, - "properties": { - "AllSupported": { - "type": "boolean" - }, - "IncludeGlobalResourceTypes": { - "type": "boolean" - }, - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Config::ConformancePack": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConformancePackInputParameters": { - "items": { - "$ref": "#/definitions/AWS::Config::ConformancePack.ConformancePackInputParameter" - }, - "type": "array" - }, - "ConformancePackName": { - "type": "string" - }, - "DeliveryS3Bucket": { - "type": "string" - }, - "DeliveryS3KeyPrefix": { - "type": "string" - }, - "TemplateBody": { - "type": "string" - }, - "TemplateS3Uri": { - "type": "string" - } - }, - "required": [ - "ConformancePackName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::ConformancePack" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::ConformancePack.ConformancePackInputParameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "AWS::Config::DeliveryChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConfigSnapshotDeliveryProperties": { - "$ref": "#/definitions/AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties" - }, - "Name": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - }, - "SnsTopicARN": { - "type": "string" - } - }, - "required": [ - "S3BucketName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::DeliveryChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::DeliveryChannel.ConfigSnapshotDeliveryProperties": { - "additionalProperties": false, - "properties": { - "DeliveryFrequency": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Config::OrganizationConfigRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExcludedAccounts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OrganizationConfigRuleName": { - "type": "string" - }, - "OrganizationCustomRuleMetadata": { - "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata" - }, - "OrganizationManagedRuleMetadata": { - "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata" - } - }, - "required": [ - "OrganizationConfigRuleName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::OrganizationConfigRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "string" - }, - "LambdaFunctionArn": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "OrganizationConfigRuleTriggerTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ResourceIdScope": { - "type": "string" - }, - "ResourceTypesScope": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TagKeyScope": { - "type": "string" - }, - "TagValueScope": { - "type": "string" - } - }, - "required": [ - "LambdaFunctionArn", - "OrganizationConfigRuleTriggerTypes" - ], - "type": "object" - }, - "AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InputParameters": { - "type": "string" - }, - "MaximumExecutionFrequency": { - "type": "string" - }, - "ResourceIdScope": { - "type": "string" - }, - "ResourceTypesScope": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RuleIdentifier": { - "type": "string" - }, - "TagKeyScope": { - "type": "string" - }, - "TagValueScope": { - "type": "string" - } - }, - "required": [ - "RuleIdentifier" - ], - "type": "object" - }, - "AWS::Config::OrganizationConformancePack": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConformancePackInputParameters": { - "items": { - "$ref": "#/definitions/AWS::Config::OrganizationConformancePack.ConformancePackInputParameter" - }, - "type": "array" - }, - "DeliveryS3Bucket": { - "type": "string" - }, - "DeliveryS3KeyPrefix": { - "type": "string" - }, - "ExcludedAccounts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OrganizationConformancePackName": { - "type": "string" - }, - "TemplateBody": { - "type": "string" - }, - "TemplateS3Uri": { - "type": "string" - } - }, - "required": [ - "OrganizationConformancePackName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::OrganizationConformancePack" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::OrganizationConformancePack.ConformancePackInputParameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "AWS::Config::RemediationConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Automatic": { - "type": "boolean" - }, - "ConfigRuleName": { - "type": "string" - }, - "ExecutionControls": { - "$ref": "#/definitions/AWS::Config::RemediationConfiguration.ExecutionControls" - }, - "MaximumAutomaticAttempts": { - "type": "number" - }, - "Parameters": { - "type": "object" - }, - "ResourceType": { - "type": "string" - }, - "RetryAttemptSeconds": { - "type": "number" - }, - "TargetId": { - "type": "string" - }, - "TargetType": { - "type": "string" - }, - "TargetVersion": { - "type": "string" - } - }, - "required": [ - "ConfigRuleName", - "TargetId", - "TargetType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::RemediationConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Config::RemediationConfiguration.ExecutionControls": { - "additionalProperties": false, - "properties": { - "SsmControls": { - "$ref": "#/definitions/AWS::Config::RemediationConfiguration.SsmControls" - } - }, - "type": "object" - }, - "AWS::Config::RemediationConfiguration.RemediationParameterValue": { - "additionalProperties": false, - "properties": { - "ResourceValue": { - "$ref": "#/definitions/AWS::Config::RemediationConfiguration.ResourceValue" - }, - "StaticValue": { - "$ref": "#/definitions/AWS::Config::RemediationConfiguration.StaticValue" - } - }, - "type": "object" - }, - "AWS::Config::RemediationConfiguration.ResourceValue": { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Config::RemediationConfiguration.SsmControls": { - "additionalProperties": false, - "properties": { - "ConcurrentExecutionRatePercentage": { - "type": "number" - }, - "ErrorPercentage": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Config::RemediationConfiguration.StaticValue": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Config::StoredQuery": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "QueryDescription": { - "type": "string" - }, - "QueryExpression": { - "type": "string" - }, - "QueryName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "QueryExpression", - "QueryName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Config::StoredQuery" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DAX::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClusterName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "IAMRoleARN": { - "type": "string" - }, - "NodeType": { - "type": "string" - }, - "NotificationTopicARN": { - "type": "string" - }, - "ParameterGroupName": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ReplicationFactor": { - "type": "number" - }, - "SSESpecification": { - "$ref": "#/definitions/AWS::DAX::Cluster.SSESpecification" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetGroupName": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "IAMRoleARN", - "NodeType", - "ReplicationFactor" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DAX::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DAX::Cluster.SSESpecification": { - "additionalProperties": false, - "properties": { - "SSEEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::DAX::ParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "ParameterGroupName": { - "type": "string" - }, - "ParameterNameValues": { - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DAX::ParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::DAX::SubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "SubnetGroupName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DAX::SubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "PolicyDetails": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.PolicyDetails" - }, - "State": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DLM::LifecyclePolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.Action": { - "additionalProperties": false, - "properties": { - "CrossRegionCopy": { - "items": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyAction" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "CrossRegionCopy", - "Name" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.CreateRule": { - "additionalProperties": false, - "properties": { - "CronExpression": { - "type": "string" - }, - "Interval": { - "type": "number" - }, - "IntervalUnit": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "Times": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.CrossRegionCopyAction": { - "additionalProperties": false, - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.EncryptionConfiguration" - }, - "RetainRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "EncryptionConfiguration", - "Target" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule": { - "additionalProperties": false, - "properties": { - "Interval": { - "type": "number" - }, - "IntervalUnit": { - "type": "string" - } - }, - "required": [ - "Interval", - "IntervalUnit" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.CrossRegionCopyRule": { - "additionalProperties": false, - "properties": { - "CmkArn": { - "type": "string" - }, - "CopyTags": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "RetainRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule" - }, - "Target": { - "type": "string" - }, - "TargetRegion": { - "type": "string" - } - }, - "required": [ - "Encrypted" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "CmkArn": { - "type": "string" - }, - "Encrypted": { - "type": "boolean" - } - }, - "required": [ - "Encrypted" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.EventParameters": { - "additionalProperties": false, - "properties": { - "DescriptionRegex": { - "type": "string" - }, - "EventType": { - "type": "string" - }, - "SnapshotOwner": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "EventType", - "SnapshotOwner" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.EventSource": { - "additionalProperties": false, - "properties": { - "Parameters": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.EventParameters" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.FastRestoreRule": { - "additionalProperties": false, - "properties": { - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Count": { - "type": "number" - }, - "Interval": { - "type": "number" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.Parameters": { - "additionalProperties": false, - "properties": { - "ExcludeBootVolume": { - "type": "boolean" - }, - "NoReboot": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.PolicyDetails": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Action" - }, - "type": "array" - }, - "EventSource": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.EventSource" - }, - "Parameters": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Parameters" - }, - "PolicyType": { - "type": "string" - }, - "ResourceLocations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ResourceTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Schedules": { - "items": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Schedule" - }, - "type": "array" - }, - "TargetTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.RetainRule": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - }, - "Interval": { - "type": "number" - }, - "IntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.Schedule": { - "additionalProperties": false, - "properties": { - "CopyTags": { - "type": "boolean" - }, - "CreateRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CreateRule" - }, - "CrossRegionCopyRules": { - "items": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRule" - }, - "type": "array" - }, - "FastRestoreRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.FastRestoreRule" - }, - "Name": { - "type": "string" - }, - "RetainRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetainRule" - }, - "ShareRules": { - "items": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ShareRule" - }, - "type": "array" - }, - "TagsToAdd": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VariableTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::DLM::LifecyclePolicy.ShareRule": { - "additionalProperties": false, - "properties": { - "TargetAccounts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UnshareInterval": { - "type": "number" - }, - "UnshareIntervalUnit": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Certificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CertificateIdentifier": { - "type": "string" - }, - "CertificatePem": { - "type": "string" - }, - "CertificateWallet": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::Certificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::DMS::Endpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DocDbSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.DocDbSettings" - }, - "DynamoDbSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.DynamoDbSettings" - }, - "ElasticsearchSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.ElasticsearchSettings" - }, - "EndpointIdentifier": { - "type": "string" - }, - "EndpointType": { - "type": "string" - }, - "EngineName": { - "type": "string" - }, - "ExtraConnectionAttributes": { - "type": "string" - }, - "IbmDb2Settings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.IbmDb2Settings" - }, - "KafkaSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.KafkaSettings" - }, - "KinesisSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.KinesisSettings" - }, - "KmsKeyId": { - "type": "string" - }, - "MicrosoftSqlServerSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.MicrosoftSqlServerSettings" - }, - "MongoDbSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.MongoDbSettings" - }, - "MySqlSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.MySqlSettings" - }, - "NeptuneSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.NeptuneSettings" - }, - "OracleSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.OracleSettings" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PostgreSqlSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.PostgreSqlSettings" - }, - "RedshiftSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.RedshiftSettings" - }, - "S3Settings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.S3Settings" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "type": "string" - }, - "SybaseSettings": { - "$ref": "#/definitions/AWS::DMS::Endpoint.SybaseSettings" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "EndpointType", - "EngineName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::Endpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DMS::Endpoint.DocDbSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.DynamoDbSettings": { - "additionalProperties": false, - "properties": { - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.ElasticsearchSettings": { - "additionalProperties": false, - "properties": { - "EndpointUri": { - "type": "string" - }, - "ErrorRetryDuration": { - "type": "number" - }, - "FullLoadErrorPercentage": { - "type": "number" - }, - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.IbmDb2Settings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.KafkaSettings": { - "additionalProperties": false, - "properties": { - "Broker": { - "type": "string" - }, - "Topic": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.KinesisSettings": { - "additionalProperties": false, - "properties": { - "MessageFormat": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - }, - "StreamArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.MicrosoftSqlServerSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.MongoDbSettings": { - "additionalProperties": false, - "properties": { - "AuthMechanism": { - "type": "string" - }, - "AuthSource": { - "type": "string" - }, - "AuthType": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DocsToInvestigate": { - "type": "string" - }, - "ExtractDocId": { - "type": "string" - }, - "NestingLevel": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.MySqlSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.NeptuneSettings": { - "additionalProperties": false, - "properties": { - "ErrorRetryDuration": { - "type": "number" - }, - "IamAuthEnabled": { - "type": "boolean" - }, - "MaxFileSize": { - "type": "number" - }, - "MaxRetryCount": { - "type": "number" - }, - "S3BucketFolder": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.OracleSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmSecretId": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.PostgreSqlSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.RedshiftSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.S3Settings": { - "additionalProperties": false, - "properties": { - "BucketFolder": { - "type": "string" - }, - "BucketName": { - "type": "string" - }, - "CompressionType": { - "type": "string" - }, - "CsvDelimiter": { - "type": "string" - }, - "CsvRowDelimiter": { - "type": "string" - }, - "ExternalTableDefinition": { - "type": "string" - }, - "ServiceAccessRoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::Endpoint.SybaseSettings": { - "additionalProperties": false, - "properties": { - "SecretsManagerAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecretId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DMS::EventSubscription": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "EventCategories": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnsTopicArn": { - "type": "string" - }, - "SourceIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceType": { - "type": "string" - }, - "SubscriptionName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "SnsTopicArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::EventSubscription" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DMS::ReplicationInstance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllocatedStorage": { - "type": "number" - }, - "AllowMajorVersionUpgrade": { - "type": "boolean" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MultiAZ": { - "type": "boolean" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "ReplicationInstanceClass": { - "type": "string" - }, - "ReplicationInstanceIdentifier": { - "type": "string" - }, - "ReplicationSubnetGroupIdentifier": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ReplicationInstanceClass" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::ReplicationInstance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DMS::ReplicationSubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ReplicationSubnetGroupDescription": { - "type": "string" - }, - "ReplicationSubnetGroupIdentifier": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ReplicationSubnetGroupDescription", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::ReplicationSubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DMS::ReplicationTask": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CdcStartPosition": { - "type": "string" - }, - "CdcStartTime": { - "type": "number" - }, - "CdcStopPosition": { - "type": "string" - }, - "MigrationType": { - "type": "string" - }, - "ReplicationInstanceArn": { - "type": "string" - }, - "ReplicationTaskIdentifier": { - "type": "string" - }, - "ReplicationTaskSettings": { - "type": "string" - }, - "SourceEndpointArn": { - "type": "string" - }, - "TableMappings": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetEndpointArn": { - "type": "string" - }, - "TaskData": { - "type": "string" - } - }, - "required": [ - "MigrationType", - "ReplicationInstanceArn", - "SourceEndpointArn", - "TableMappings", - "TargetEndpointArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DMS::ReplicationTask" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataBrew::Dataset": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Format": { - "type": "string" - }, - "FormatOptions": { - "type": "object" - }, - "Input": { - "type": "object" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Input", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataBrew::Dataset" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataBrew::Job": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "type": "string" - }, - "EncryptionKeyArn": { - "type": "string" - }, - "EncryptionMode": { - "type": "string" - }, - "JobSample": { - "type": "object" - }, - "LogSubscription": { - "type": "string" - }, - "MaxCapacity": { - "type": "number" - }, - "MaxRetries": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "OutputLocation": { - "type": "object" - }, - "Outputs": { - "items": { - "$ref": "#/definitions/AWS::DataBrew::Job.Output" - }, - "type": "array" - }, - "ProjectName": { - "type": "string" - }, - "Recipe": { - "type": "object" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Timeout": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "RoleArn", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataBrew::Job" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataBrew::Job.CsvOutputOptions": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataBrew::Job.Output": { - "additionalProperties": false, - "properties": { - "CompressionFormat": { - "type": "string" - }, - "Format": { - "type": "string" - }, - "FormatOptions": { - "$ref": "#/definitions/AWS::DataBrew::Job.OutputFormatOptions" - }, - "Location": { - "$ref": "#/definitions/AWS::DataBrew::Job.S3Location" - }, - "Overwrite": { - "type": "boolean" - }, - "PartitionColumns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Location" - ], - "type": "object" - }, - "AWS::DataBrew::Job.OutputFormatOptions": { - "additionalProperties": false, - "properties": { - "Csv": { - "$ref": "#/definitions/AWS::DataBrew::Job.CsvOutputOptions" - } - }, - "type": "object" - }, - "AWS::DataBrew::Job.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "AWS::DataBrew::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RecipeName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Sample": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DatasetName", - "Name", - "RecipeName", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataBrew::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Steps": { - "items": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.RecipeStep" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Steps" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataBrew::Recipe" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe.Action": { - "additionalProperties": false, - "properties": { - "Operation": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "required": [ - "Operation" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe.ConditionExpression": { - "additionalProperties": false, - "properties": { - "Condition": { - "type": "string" - }, - "TargetColumn": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Condition", - "TargetColumn" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe.DataCatalogInputDefinition": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "TableName": { - "type": "string" - }, - "TempDirectory": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location" - } - }, - "type": "object" - }, - "AWS::DataBrew::Recipe.RecipeParameters": { - "additionalProperties": false, - "properties": { - "AggregateFunction": { - "type": "string" - }, - "Base": { - "type": "string" - }, - "CaseStatement": { - "type": "string" - }, - "CategoryMap": { - "type": "string" - }, - "CharsToRemove": { - "type": "string" - }, - "CollapseConsecutiveWhitespace": { - "type": "string" - }, - "ColumnDataType": { - "type": "string" - }, - "ColumnRange": { - "type": "string" - }, - "Count": { - "type": "string" - }, - "CustomCharacters": { - "type": "string" - }, - "CustomStopWords": { - "type": "string" - }, - "CustomValue": { - "type": "string" - }, - "DatasetsColumns": { - "type": "string" - }, - "DateAddValue": { - "type": "string" - }, - "DateTimeFormat": { - "type": "string" - }, - "DateTimeParameters": { - "type": "string" - }, - "DeleteOtherRows": { - "type": "string" - }, - "Delimiter": { - "type": "string" - }, - "EndPattern": { - "type": "string" - }, - "EndPosition": { - "type": "string" - }, - "EndValue": { - "type": "string" - }, - "ExpandContractions": { - "type": "string" - }, - "Exponent": { - "type": "string" - }, - "FalseString": { - "type": "string" - }, - "GroupByAggFunctionOptions": { - "type": "string" - }, - "GroupByColumns": { - "type": "string" - }, - "HiddenColumns": { - "type": "string" - }, - "IgnoreCase": { - "type": "string" - }, - "IncludeInSplit": { - "type": "string" - }, - "Input": { - "type": "object" - }, - "Interval": { - "type": "string" - }, - "IsText": { - "type": "string" - }, - "JoinKeys": { - "type": "string" - }, - "JoinType": { - "type": "string" - }, - "LeftColumns": { - "type": "string" - }, - "Limit": { - "type": "string" - }, - "LowerBound": { - "type": "string" - }, - "MapType": { - "type": "string" - }, - "ModeType": { - "type": "string" - }, - "MultiLine": { - "type": "boolean" - }, - "NumRows": { - "type": "string" - }, - "NumRowsAfter": { - "type": "string" - }, - "NumRowsBefore": { - "type": "string" - }, - "OrderByColumn": { - "type": "string" - }, - "OrderByColumns": { - "type": "string" - }, - "Other": { - "type": "string" - }, - "Pattern": { - "type": "string" - }, - "PatternOption1": { - "type": "string" - }, - "PatternOption2": { - "type": "string" - }, - "PatternOptions": { - "type": "string" - }, - "Period": { - "type": "string" - }, - "Position": { - "type": "string" - }, - "RemoveAllPunctuation": { - "type": "string" - }, - "RemoveAllQuotes": { - "type": "string" - }, - "RemoveAllWhitespace": { - "type": "string" - }, - "RemoveCustomCharacters": { - "type": "string" - }, - "RemoveCustomValue": { - "type": "string" - }, - "RemoveLeadingAndTrailingPunctuation": { - "type": "string" - }, - "RemoveLeadingAndTrailingQuotes": { - "type": "string" - }, - "RemoveLeadingAndTrailingWhitespace": { - "type": "string" - }, - "RemoveLetters": { - "type": "string" - }, - "RemoveNumbers": { - "type": "string" - }, - "RemoveSourceColumn": { - "type": "string" - }, - "RemoveSpecialCharacters": { - "type": "string" - }, - "RightColumns": { - "type": "string" - }, - "SampleSize": { - "type": "string" - }, - "SampleType": { - "type": "string" - }, - "SecondInput": { - "type": "string" - }, - "SecondaryInputs": { - "items": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.SecondaryInput" - }, - "type": "array" - }, - "SheetIndexes": { - "items": { - "type": "number" - }, - "type": "array" - }, - "SheetNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceColumn": { - "type": "string" - }, - "SourceColumn1": { - "type": "string" - }, - "SourceColumn2": { - "type": "string" - }, - "SourceColumns": { - "type": "string" - }, - "StartColumnIndex": { - "type": "string" - }, - "StartPattern": { - "type": "string" - }, - "StartPosition": { - "type": "string" - }, - "StartValue": { - "type": "string" - }, - "StemmingMode": { - "type": "string" - }, - "StepCount": { - "type": "string" - }, - "StepIndex": { - "type": "string" - }, - "StopWordsMode": { - "type": "string" - }, - "Strategy": { - "type": "string" - }, - "TargetColumn": { - "type": "string" - }, - "TargetColumnNames": { - "type": "string" - }, - "TargetDateFormat": { - "type": "string" - }, - "TargetIndex": { - "type": "string" - }, - "TimeZone": { - "type": "string" - }, - "TokenizerPattern": { - "type": "string" - }, - "TrueString": { - "type": "string" - }, - "UdfLang": { - "type": "string" - }, - "Units": { - "type": "string" - }, - "UnpivotColumn": { - "type": "string" - }, - "UpperBound": { - "type": "string" - }, - "UseNewDataFrame": { - "type": "string" - }, - "Value": { - "type": "string" - }, - "Value1": { - "type": "string" - }, - "Value2": { - "type": "string" - }, - "ValueColumn": { - "type": "string" - }, - "ViewFrame": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataBrew::Recipe.RecipeStep": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.Action" - }, - "ConditionExpressions": { - "items": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.ConditionExpression" - }, - "type": "array" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "AWS::DataBrew::Recipe.SecondaryInput": { - "additionalProperties": false, - "properties": { - "DataCatalogInputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.DataCatalogInputDefinition" - }, - "S3InputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location" - } - }, - "type": "object" - }, - "AWS::DataBrew::Schedule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CronExpression": { - "type": "string" - }, - "JobNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "CronExpression", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataBrew::Schedule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Activate": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ParameterObjects": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterObject" - }, - "type": "array" - }, - "ParameterValues": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterValue" - }, - "type": "array" - }, - "PipelineObjects": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineObject" - }, - "type": "array" - }, - "PipelineTags": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineTag" - }, - "type": "array" - } - }, - "required": [ - "Name", - "ParameterObjects" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataPipeline::Pipeline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.Field": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "RefValue": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.ParameterAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "required": [ - "Key", - "StringValue" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.ParameterObject": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterAttribute" - }, - "type": "array" - }, - "Id": { - "type": "string" - } - }, - "required": [ - "Attributes", - "Id" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.ParameterValue": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "required": [ - "Id", - "StringValue" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.PipelineObject": { - "additionalProperties": false, - "properties": { - "Fields": { - "items": { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline.Field" - }, - "type": "array" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Fields", - "Id", - "Name" - ], - "type": "object" - }, - "AWS::DataPipeline::Pipeline.PipelineTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::DataSync::Agent": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ActivationKey": { - "type": "string" - }, - "AgentName": { - "type": "string" - }, - "SecurityGroupArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcEndpointId": { - "type": "string" - } - }, - "required": [ - "ActivationKey" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::Agent" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationEFS": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Ec2Config": { - "$ref": "#/definitions/AWS::DataSync::LocationEFS.Ec2Config" - }, - "EfsFilesystemArn": { - "type": "string" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Ec2Config", - "EfsFilesystemArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationEFS" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationEFS.Ec2Config": { - "additionalProperties": false, - "properties": { - "SecurityGroupArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetArn": { - "type": "string" - } - }, - "required": [ - "SecurityGroupArns", - "SubnetArn" - ], - "type": "object" - }, - "AWS::DataSync::LocationFSxWindows": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Domain": { - "type": "string" - }, - "FsxFilesystemArn": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "SecurityGroupArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "User": { - "type": "string" - } - }, - "required": [ - "FsxFilesystemArn", - "Password", - "SecurityGroupArns", - "User" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationFSxWindows" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationNFS": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationNFS.MountOptions" - }, - "OnPremConfig": { - "$ref": "#/definitions/AWS::DataSync::LocationNFS.OnPremConfig" - }, - "ServerHostname": { - "type": "string" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "OnPremConfig", - "ServerHostname", - "Subdirectory" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationNFS" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationNFS.MountOptions": { - "additionalProperties": false, - "properties": { - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataSync::LocationNFS.OnPremConfig": { - "additionalProperties": false, - "properties": { - "AgentArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "AgentArns" - ], - "type": "object" - }, - "AWS::DataSync::LocationObjectStorage": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessKey": { - "type": "string" - }, - "AgentArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BucketName": { - "type": "string" - }, - "SecretKey": { - "type": "string" - }, - "ServerHostname": { - "type": "string" - }, - "ServerPort": { - "type": "number" - }, - "ServerProtocol": { - "type": "string" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AgentArns", - "BucketName", - "ServerHostname" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationObjectStorage" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationS3": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "S3BucketArn": { - "type": "string" - }, - "S3Config": { - "$ref": "#/definitions/AWS::DataSync::LocationS3.S3Config" - }, - "S3StorageClass": { - "type": "string" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "S3BucketArn", - "S3Config" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationS3" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationS3.S3Config": { - "additionalProperties": false, - "properties": { - "BucketAccessRoleArn": { - "type": "string" - } - }, - "required": [ - "BucketAccessRoleArn" - ], - "type": "object" - }, - "AWS::DataSync::LocationSMB": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AgentArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Domain": { - "type": "string" - }, - "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationSMB.MountOptions" - }, - "Password": { - "type": "string" - }, - "ServerHostname": { - "type": "string" - }, - "Subdirectory": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "User": { - "type": "string" - } - }, - "required": [ - "AgentArns", - "Password", - "ServerHostname", - "Subdirectory", - "User" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::LocationSMB" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::LocationSMB.MountOptions": { - "additionalProperties": false, - "properties": { - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataSync::Task": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CloudWatchLogGroupArn": { - "type": "string" - }, - "DestinationLocationArn": { - "type": "string" - }, - "Excludes": { - "items": { - "$ref": "#/definitions/AWS::DataSync::Task.FilterRule" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Options": { - "$ref": "#/definitions/AWS::DataSync::Task.Options" - }, - "Schedule": { - "$ref": "#/definitions/AWS::DataSync::Task.TaskSchedule" - }, - "SourceLocationArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DestinationLocationArn", - "SourceLocationArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DataSync::Task" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DataSync::Task.FilterRule": { - "additionalProperties": false, - "properties": { - "FilterType": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataSync::Task.Options": { - "additionalProperties": false, - "properties": { - "Atime": { - "type": "string" - }, - "BytesPerSecond": { - "type": "number" - }, - "Gid": { - "type": "string" - }, - "LogLevel": { - "type": "string" - }, - "Mtime": { - "type": "string" - }, - "OverwriteMode": { - "type": "string" - }, - "PosixPermissions": { - "type": "string" - }, - "PreserveDeletedFiles": { - "type": "string" - }, - "PreserveDevices": { - "type": "string" - }, - "TaskQueueing": { - "type": "string" - }, - "TransferMode": { - "type": "string" - }, - "Uid": { - "type": "string" - }, - "VerifyMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DataSync::Task.TaskSchedule": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "AWS::Detective::Graph": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Detective::Graph" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Detective::MemberInvitation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DisableEmailNotification": { - "type": "boolean" - }, - "GraphArn": { - "type": "string" - }, - "MemberEmailAddress": { - "type": "string" - }, - "MemberId": { - "type": "string" - }, - "Message": { - "type": "string" - } - }, - "required": [ - "GraphArn", - "MemberEmailAddress", - "MemberId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Detective::MemberInvitation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DevOpsGuru::NotificationChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Config": { - "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.NotificationChannelConfig" - } - }, - "required": [ - "Config" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DevOpsGuru::NotificationChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DevOpsGuru::NotificationChannel.NotificationChannelConfig": { - "additionalProperties": false, - "properties": { - "Sns": { - "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig" - } - }, - "type": "object" - }, - "AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig": { - "additionalProperties": false, - "properties": { - "TopicArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DevOpsGuru::ResourceCollection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceCollectionFilter": { - "$ref": "#/definitions/AWS::DevOpsGuru::ResourceCollection.ResourceCollectionFilter" - } - }, - "required": [ - "ResourceCollectionFilter" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DevOpsGuru::ResourceCollection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DevOpsGuru::ResourceCollection.CloudFormationCollectionFilter": { - "additionalProperties": false, - "properties": { - "StackNames": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::DevOpsGuru::ResourceCollection.ResourceCollectionFilter": { - "additionalProperties": false, - "properties": { - "CloudFormation": { - "$ref": "#/definitions/AWS::DevOpsGuru::ResourceCollection.CloudFormationCollectionFilter" - } - }, - "type": "object" - }, - "AWS::DirectoryService::MicrosoftAD": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CreateAlias": { - "type": "boolean" - }, - "Edition": { - "type": "string" - }, - "EnableSso": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "ShortName": { - "type": "string" - }, - "VpcSettings": { - "$ref": "#/definitions/AWS::DirectoryService::MicrosoftAD.VpcSettings" - } - }, - "required": [ - "Name", - "Password", - "VpcSettings" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DirectoryService::MicrosoftAD" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DirectoryService::MicrosoftAD.VpcSettings": { - "additionalProperties": false, - "properties": { - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "SubnetIds", - "VpcId" - ], - "type": "object" - }, - "AWS::DirectoryService::SimpleAD": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CreateAlias": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "EnableSso": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "ShortName": { - "type": "string" - }, - "Size": { - "type": "string" - }, - "VpcSettings": { - "$ref": "#/definitions/AWS::DirectoryService::SimpleAD.VpcSettings" - } - }, - "required": [ - "Name", - "Password", - "Size", - "VpcSettings" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DirectoryService::SimpleAD" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DirectoryService::SimpleAD.VpcSettings": { - "additionalProperties": false, - "properties": { - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "SubnetIds", - "VpcId" - ], - "type": "object" - }, - "AWS::DocDB::DBCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BackupRetentionPeriod": { - "type": "number" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBClusterParameterGroupName": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "DeletionProtection": { - "type": "boolean" - }, - "EnableCloudwatchLogsExports": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EngineVersion": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - }, - "MasterUsername": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "SnapshotIdentifier": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "MasterUserPassword", - "MasterUsername" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DocDB::DBCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DocDB::DBClusterParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "Family", - "Parameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DocDB::DBClusterParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DocDB::DBInstance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBInstanceClass": { - "type": "string" - }, - "DBInstanceIdentifier": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBClusterIdentifier", - "DBInstanceClass" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DocDB::DBInstance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DocDB::DBSubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DBSubnetGroupDescription": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DocDB::DBSubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DynamoDB::Table": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AttributeDefinitions": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.AttributeDefinition" - }, - "type": "array" - }, - "BillingMode": { - "type": "string" - }, - "ContributorInsightsSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification" - }, - "GlobalSecondaryIndexes": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.GlobalSecondaryIndex" - }, - "type": "array" - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" - }, - "type": "array" - }, - "LocalSecondaryIndexes": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.LocalSecondaryIndex" - }, - "type": "array" - }, - "PointInTimeRecoverySpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.PointInTimeRecoverySpecification" - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput" - }, - "SSESpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.SSESpecification" - }, - "StreamSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.StreamSpecification" - }, - "TableName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TimeToLiveSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.TimeToLiveSpecification" - } - }, - "required": [ - "KeySchema" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::DynamoDB::Table" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.AttributeDefinition": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "type": "string" - }, - "AttributeType": { - "type": "string" - } - }, - "required": [ - "AttributeName", - "AttributeType" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.ContributorInsightsSpecification": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.GlobalSecondaryIndex": { - "additionalProperties": false, - "properties": { - "ContributorInsightsSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification" - }, - "IndexName": { - "type": "string" - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" - }, - "type": "array" - }, - "Projection": { - "$ref": "#/definitions/AWS::DynamoDB::Table.Projection" - }, - "ProvisionedThroughput": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput" - } - }, - "required": [ - "IndexName", - "KeySchema", - "Projection" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.KeySchema": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "type": "string" - }, - "KeyType": { - "type": "string" - } - }, - "required": [ - "AttributeName", - "KeyType" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.LocalSecondaryIndex": { - "additionalProperties": false, - "properties": { - "IndexName": { - "type": "string" - }, - "KeySchema": { - "items": { - "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" - }, - "type": "array" - }, - "Projection": { - "$ref": "#/definitions/AWS::DynamoDB::Table.Projection" - } - }, - "required": [ - "IndexName", - "KeySchema", - "Projection" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.PointInTimeRecoverySpecification": { - "additionalProperties": false, - "properties": { - "PointInTimeRecoveryEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::DynamoDB::Table.Projection": { - "additionalProperties": false, - "properties": { - "NonKeyAttributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ProjectionType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::DynamoDB::Table.ProvisionedThroughput": { - "additionalProperties": false, - "properties": { - "ReadCapacityUnits": { - "type": "number" - }, - "WriteCapacityUnits": { - "type": "number" - } - }, - "required": [ - "ReadCapacityUnits", - "WriteCapacityUnits" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.SSESpecification": { - "additionalProperties": false, - "properties": { - "KMSMasterKeyId": { - "type": "string" - }, - "SSEEnabled": { - "type": "boolean" - }, - "SSEType": { - "type": "string" - } - }, - "required": [ - "SSEEnabled" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.StreamSpecification": { - "additionalProperties": false, - "properties": { - "StreamViewType": { - "type": "string" - } - }, - "required": [ - "StreamViewType" - ], - "type": "object" - }, - "AWS::DynamoDB::Table.TimeToLiveSpecification": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "AttributeName", - "Enabled" - ], - "type": "object" - }, - "AWS::EC2::CapacityReservation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "EbsOptimized": { - "type": "boolean" - }, - "EndDate": { - "type": "string" - }, - "EndDateType": { - "type": "string" - }, - "EphemeralStorage": { - "type": "boolean" - }, - "InstanceCount": { - "type": "number" - }, - "InstanceMatchCriteria": { - "type": "string" - }, - "InstancePlatform": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::CapacityReservation.TagSpecification" - }, - "type": "array" - }, - "Tenancy": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone", - "InstanceCount", - "InstancePlatform", - "InstanceType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::CapacityReservation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::CapacityReservation.TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::CarrierGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::CarrierGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnAuthorizationRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessGroupId": { - "type": "string" - }, - "AuthorizeAllGroups": { - "type": "boolean" - }, - "ClientVpnEndpointId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "TargetNetworkCidr": { - "type": "string" - } - }, - "required": [ - "ClientVpnEndpointId", - "TargetNetworkCidr" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::ClientVpnAuthorizationRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationOptions": { - "items": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest" - }, - "type": "array" - }, - "ClientCidrBlock": { - "type": "string" - }, - "ClientConnectOptions": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.ClientConnectOptions" - }, - "ConnectionLogOptions": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions" - }, - "Description": { - "type": "string" - }, - "DnsServers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SelfServicePortal": { - "type": "string" - }, - "ServerCertificateArn": { - "type": "string" - }, - "SplitTunnel": { - "type": "boolean" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.TagSpecification" - }, - "type": "array" - }, - "TransportProtocol": { - "type": "string" - }, - "VpcId": { - "type": "string" - }, - "VpnPort": { - "type": "number" - } - }, - "required": [ - "AuthenticationOptions", - "ClientCidrBlock", - "ConnectionLogOptions", - "ServerCertificateArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::ClientVpnEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "ClientRootCertificateChainArn": { - "type": "string" - } - }, - "required": [ - "ClientRootCertificateChainArn" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.ClientAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "ActiveDirectory": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest" - }, - "FederatedAuthentication": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.FederatedAuthenticationRequest" - }, - "MutualAuthentication": { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint.CertificateAuthenticationRequest" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.ClientConnectOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LambdaFunctionArn": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions": { - "additionalProperties": false, - "properties": { - "CloudwatchLogGroup": { - "type": "string" - }, - "CloudwatchLogStream": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.DirectoryServiceAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "DirectoryId": { - "type": "string" - } - }, - "required": [ - "DirectoryId" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.FederatedAuthenticationRequest": { - "additionalProperties": false, - "properties": { - "SAMLProviderArn": { - "type": "string" - }, - "SelfServiceSAMLProviderArn": { - "type": "string" - } - }, - "required": [ - "SAMLProviderArn" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnEndpoint.TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ResourceType", - "Tags" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnRoute": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClientVpnEndpointId": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "TargetVpcSubnetId": { - "type": "string" - } - }, - "required": [ - "ClientVpnEndpointId", - "DestinationCidrBlock", - "TargetVpcSubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::ClientVpnRoute" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::ClientVpnTargetNetworkAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClientVpnEndpointId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "ClientVpnEndpointId", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::ClientVpnTargetNetworkAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::CustomerGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BgpAsn": { - "type": "number" - }, - "IpAddress": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "BgpAsn", - "IpAddress", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::CustomerGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::DHCPOptions": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "DomainNameServers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "NetbiosNameServers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "NetbiosNodeType": { - "type": "number" - }, - "NtpServers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::DHCPOptions" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::EC2Fleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExcessCapacityTerminationPolicy": { - "type": "string" - }, - "LaunchTemplateConfigs": { - "items": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest" - }, - "type": "array" - }, - "OnDemandOptions": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.OnDemandOptionsRequest" - }, - "ReplaceUnhealthyInstances": { - "type": "boolean" - }, - "SpotOptions": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.SpotOptionsRequest" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.TagSpecification" - }, - "type": "array" - }, - "TargetCapacitySpecification": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest" - }, - "TerminateInstancesWithExpiration": { - "type": "boolean" - }, - "Type": { - "type": "string" - }, - "ValidFrom": { - "type": "string" - }, - "ValidUntil": { - "type": "string" - } - }, - "required": [ - "LaunchTemplateConfigs", - "TargetCapacitySpecification" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::EC2Fleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::EC2Fleet.CapacityReservationOptionsRequest": { - "additionalProperties": false, - "properties": { - "UsageStrategy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.FleetLaunchTemplateConfigRequest": { - "additionalProperties": false, - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.FleetLaunchTemplateOverridesRequest": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "MaxPrice": { - "type": "string" - }, - "Placement": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.Placement" - }, - "Priority": { - "type": "number" - }, - "SubnetId": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.FleetLaunchTemplateSpecificationRequest": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.OnDemandOptionsRequest": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "CapacityReservationOptions": { - "$ref": "#/definitions/AWS::EC2::EC2Fleet.CapacityReservationOptionsRequest" - }, - "MaxTotalPrice": { - "type": "string" - }, - "MinTargetCapacity": { - "type": "number" - }, - "SingleAvailabilityZone": { - "type": "boolean" - }, - "SingleInstanceType": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.Placement": { - "additionalProperties": false, - "properties": { - "Affinity": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "HostId": { - "type": "string" - }, - "HostResourceGroupArn": { - "type": "string" - }, - "PartitionNumber": { - "type": "number" - }, - "SpreadDomain": { - "type": "string" - }, - "Tenancy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.SpotOptionsRequest": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "InstanceInterruptionBehavior": { - "type": "string" - }, - "InstancePoolsToUseCount": { - "type": "number" - }, - "MaxTotalPrice": { - "type": "string" - }, - "MinTargetCapacity": { - "type": "number" - }, - "SingleAvailabilityZone": { - "type": "boolean" - }, - "SingleInstanceType": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::EC2Fleet.TargetCapacitySpecificationRequest": { - "additionalProperties": false, - "properties": { - "DefaultTargetCapacityType": { - "type": "string" - }, - "OnDemandTargetCapacity": { - "type": "number" - }, - "SpotTargetCapacity": { - "type": "number" - }, - "TotalTargetCapacity": { - "type": "number" - } - }, - "required": [ - "TotalTargetCapacity" - ], - "type": "object" - }, - "AWS::EC2::EIP": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Domain": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "PublicIpv4Pool": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::EIP" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::EIPAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllocationId": { - "type": "string" - }, - "EIP": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::EIPAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::EgressOnlyInternetGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::EgressOnlyInternetGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::FlowLog": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeliverLogsPermissionArn": { - "type": "string" - }, - "LogDestination": { - "type": "string" - }, - "LogDestinationType": { - "type": "string" - }, - "LogFormat": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "MaxAggregationInterval": { - "type": "number" - }, - "ResourceId": { - "type": "string" - }, - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TrafficType": { - "type": "string" - } - }, - "required": [ - "ResourceId", - "ResourceType", - "TrafficType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::FlowLog" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::GatewayRouteTableAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GatewayId": { - "type": "string" - }, - "RouteTableId": { - "type": "string" - } - }, - "required": [ - "GatewayId", - "RouteTableId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::GatewayRouteTableAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::Host": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoPlacement": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "HostRecovery": { - "type": "string" - }, - "InstanceType": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone", - "InstanceType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::Host" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::Instance": { - "additionalProperties": false, - "properties": { - "CreationPolicy": { - "type": "object" - }, - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdditionalInfo": { - "type": "string" - }, - "Affinity": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.BlockDeviceMapping" - }, - "type": "array" - }, - "CpuOptions": { - "$ref": "#/definitions/AWS::EC2::Instance.CpuOptions" - }, - "CreditSpecification": { - "$ref": "#/definitions/AWS::EC2::Instance.CreditSpecification" - }, - "DisableApiTermination": { - "type": "boolean" - }, - "EbsOptimized": { - "type": "boolean" - }, - "ElasticGpuSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.ElasticGpuSpecification" - }, - "type": "array" - }, - "ElasticInferenceAccelerators": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.ElasticInferenceAccelerator" - }, - "type": "array" - }, - "EnclaveOptions": { - "$ref": "#/definitions/AWS::EC2::Instance.EnclaveOptions" - }, - "HibernationOptions": { - "$ref": "#/definitions/AWS::EC2::Instance.HibernationOptions" - }, - "HostId": { - "type": "string" - }, - "HostResourceGroupArn": { - "type": "string" - }, - "IamInstanceProfile": { - "type": "string" - }, - "ImageId": { - "type": "string" - }, - "InstanceInitiatedShutdownBehavior": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Ipv6AddressCount": { - "type": "number" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.InstanceIpv6Address" - }, - "type": "array" - }, - "KernelId": { - "type": "string" - }, - "KeyName": { - "type": "string" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::EC2::Instance.LaunchTemplateSpecification" - }, - "LicenseSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.LicenseSpecification" - }, - "type": "array" - }, - "Monitoring": { - "type": "boolean" - }, - "NetworkInterfaces": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.NetworkInterface" - }, - "type": "array" - }, - "PlacementGroupName": { - "type": "string" - }, - "PrivateIpAddress": { - "type": "string" - }, - "RamdiskId": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceDestCheck": { - "type": "boolean" - }, - "SsmAssociations": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.SsmAssociation" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Tenancy": { - "type": "string" - }, - "UserData": { - "type": "string" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.Volume" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::Instance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::Instance.AssociationParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EC2::Instance.BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::EC2::Instance.Ebs" - }, - "NoDevice": { - "$ref": "#/definitions/AWS::EC2::Instance.NoDevice" - }, - "VirtualName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "AWS::EC2::Instance.CpuOptions": { - "additionalProperties": false, - "properties": { - "CoreCount": { - "type": "number" - }, - "ThreadsPerCore": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::Instance.CreditSpecification": { - "additionalProperties": false, - "properties": { - "CPUCredits": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::Instance.Ebs": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::Instance.ElasticGpuSpecification": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::Instance.ElasticInferenceAccelerator": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::Instance.EnclaveOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::Instance.HibernationOptions": { - "additionalProperties": false, - "properties": { - "Configured": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::Instance.InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "AWS::EC2::Instance.LaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "AWS::EC2::Instance.LicenseSpecification": { - "additionalProperties": false, - "properties": { - "LicenseConfigurationArn": { - "type": "string" - } - }, - "required": [ - "LicenseConfigurationArn" - ], - "type": "object" - }, - "AWS::EC2::Instance.NetworkInterface": { - "additionalProperties": false, - "properties": { - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "DeleteOnTermination": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DeviceIndex": { - "type": "string" - }, - "GroupSet": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Ipv6AddressCount": { - "type": "number" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.InstanceIpv6Address" - }, - "type": "array" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddress": { - "type": "string" - }, - "PrivateIpAddresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.PrivateIpAddressSpecification" - }, - "type": "array" - }, - "SecondaryPrivateIpAddressCount": { - "type": "number" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "DeviceIndex" - ], - "type": "object" - }, - "AWS::EC2::Instance.NoDevice": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::EC2::Instance.PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "required": [ - "Primary", - "PrivateIpAddress" - ], - "type": "object" - }, - "AWS::EC2::Instance.SsmAssociation": { - "additionalProperties": false, - "properties": { - "AssociationParameters": { - "items": { - "$ref": "#/definitions/AWS::EC2::Instance.AssociationParameter" - }, - "type": "array" - }, - "DocumentName": { - "type": "string" - } - }, - "required": [ - "DocumentName" - ], - "type": "object" - }, - "AWS::EC2::Instance.Volume": { - "additionalProperties": false, - "properties": { - "Device": { - "type": "string" - }, - "VolumeId": { - "type": "string" - } - }, - "required": [ - "Device", - "VolumeId" - ], - "type": "object" - }, - "AWS::EC2::InternetGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::InternetGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::LaunchTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LaunchTemplateData": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.LaunchTemplateData" - }, - "LaunchTemplateName": { - "type": "string" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.TagSpecification" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::LaunchTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::LaunchTemplate.BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.Ebs" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.CapacityReservationSpecification": { - "additionalProperties": false, - "properties": { - "CapacityReservationPreference": { - "type": "string" - }, - "CapacityReservationTarget": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.CapacityReservationTarget" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.CapacityReservationTarget": { - "additionalProperties": false, - "properties": { - "CapacityReservationId": { - "type": "string" - }, - "CapacityReservationResourceGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.CpuOptions": { - "additionalProperties": false, - "properties": { - "CoreCount": { - "type": "number" - }, - "ThreadsPerCore": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.CreditSpecification": { - "additionalProperties": false, - "properties": { - "CpuCredits": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.Ebs": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - }, - "SnapshotId": { - "type": "string" - }, - "Throughput": { - "type": "number" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.ElasticGpuSpecification": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.EnclaveOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.HibernationOptions": { - "additionalProperties": false, - "properties": { - "Configured": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.IamInstanceProfile": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.InstanceMarketOptions": { - "additionalProperties": false, - "properties": { - "MarketType": { - "type": "string" - }, - "SpotOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.SpotOptions" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.Ipv6Add": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.LaunchTemplateData": { - "additionalProperties": false, - "properties": { - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.BlockDeviceMapping" - }, - "type": "array" - }, - "CapacityReservationSpecification": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.CapacityReservationSpecification" - }, - "CpuOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.CpuOptions" - }, - "CreditSpecification": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.CreditSpecification" - }, - "DisableApiTermination": { - "type": "boolean" - }, - "EbsOptimized": { - "type": "boolean" - }, - "ElasticGpuSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.ElasticGpuSpecification" - }, - "type": "array" - }, - "ElasticInferenceAccelerators": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator" - }, - "type": "array" - }, - "EnclaveOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.EnclaveOptions" - }, - "HibernationOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.HibernationOptions" - }, - "IamInstanceProfile": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.IamInstanceProfile" - }, - "ImageId": { - "type": "string" - }, - "InstanceInitiatedShutdownBehavior": { - "type": "string" - }, - "InstanceMarketOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.InstanceMarketOptions" - }, - "InstanceType": { - "type": "string" - }, - "KernelId": { - "type": "string" - }, - "KeyName": { - "type": "string" - }, - "LicenseSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.LicenseSpecification" - }, - "type": "array" - }, - "MetadataOptions": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.MetadataOptions" - }, - "Monitoring": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.Monitoring" - }, - "NetworkInterfaces": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.NetworkInterface" - }, - "type": "array" - }, - "Placement": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.Placement" - }, - "RamDiskId": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.TagSpecification" - }, - "type": "array" - }, - "UserData": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.LaunchTemplateElasticInferenceAccelerator": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.LicenseSpecification": { - "additionalProperties": false, - "properties": { - "LicenseConfigurationArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.MetadataOptions": { - "additionalProperties": false, - "properties": { - "HttpEndpoint": { - "type": "string" - }, - "HttpPutResponseHopLimit": { - "type": "number" - }, - "HttpTokens": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.Monitoring": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.NetworkInterface": { - "additionalProperties": false, - "properties": { - "AssociateCarrierIpAddress": { - "type": "boolean" - }, - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "DeleteOnTermination": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DeviceIndex": { - "type": "number" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "InterfaceType": { - "type": "string" - }, - "Ipv6AddressCount": { - "type": "number" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.Ipv6Add" - }, - "type": "array" - }, - "NetworkCardIndex": { - "type": "number" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddress": { - "type": "string" - }, - "PrivateIpAddresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate.PrivateIpAdd" - }, - "type": "array" - }, - "SecondaryPrivateIpAddressCount": { - "type": "number" - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.Placement": { - "additionalProperties": false, - "properties": { - "Affinity": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "HostId": { - "type": "string" - }, - "HostResourceGroupArn": { - "type": "string" - }, - "PartitionNumber": { - "type": "number" - }, - "SpreadDomain": { - "type": "string" - }, - "Tenancy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.PrivateIpAdd": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.SpotOptions": { - "additionalProperties": false, - "properties": { - "BlockDurationMinutes": { - "type": "number" - }, - "InstanceInterruptionBehavior": { - "type": "string" - }, - "MaxPrice": { - "type": "string" - }, - "SpotInstanceType": { - "type": "string" - }, - "ValidUntil": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::LaunchTemplate.TagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::LocalGatewayRoute": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationCidrBlock": { - "type": "string" - }, - "LocalGatewayRouteTableId": { - "type": "string" - }, - "LocalGatewayVirtualInterfaceGroupId": { - "type": "string" - } - }, - "required": [ - "DestinationCidrBlock", - "LocalGatewayRouteTableId", - "LocalGatewayVirtualInterfaceGroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::LocalGatewayRoute" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::LocalGatewayRouteTableVPCAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LocalGatewayRouteTableId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "LocalGatewayRouteTableId", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::LocalGatewayRouteTableVPCAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NatGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllocationId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AllocationId", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NatGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkAcl": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkAcl" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkAclEntry": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CidrBlock": { - "type": "string" - }, - "Egress": { - "type": "boolean" - }, - "Icmp": { - "$ref": "#/definitions/AWS::EC2::NetworkAclEntry.Icmp" - }, - "Ipv6CidrBlock": { - "type": "string" - }, - "NetworkAclId": { - "type": "string" - }, - "PortRange": { - "$ref": "#/definitions/AWS::EC2::NetworkAclEntry.PortRange" - }, - "Protocol": { - "type": "number" - }, - "RuleAction": { - "type": "string" - }, - "RuleNumber": { - "type": "number" - } - }, - "required": [ - "NetworkAclId", - "Protocol", - "RuleAction", - "RuleNumber" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkAclEntry" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkAclEntry.Icmp": { - "additionalProperties": false, - "properties": { - "Code": { - "type": "number" - }, - "Type": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkAclEntry.PortRange": { - "additionalProperties": false, - "properties": { - "From": { - "type": "number" - }, - "To": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FilterInArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "NetworkInsightsPathId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "NetworkInsightsPathId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkInsightsAnalysis" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AlternatePathHint": { - "additionalProperties": false, - "properties": { - "ComponentArn": { - "type": "string" - }, - "ComponentId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisAclRule": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Egress": { - "type": "boolean" - }, - "PortRange": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.PortRange" - }, - "Protocol": { - "type": "string" - }, - "RuleAction": { - "type": "string" - }, - "RuleNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerListener": { - "additionalProperties": false, - "properties": { - "InstancePort": { - "type": "number" - }, - "LoadBalancerPort": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerTarget": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "Instance": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Port": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisPacketHeader": { - "additionalProperties": false, - "properties": { - "DestinationAddresses": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DestinationPortRanges": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.PortRange" - }, - "type": "array" - }, - "Protocol": { - "type": "string" - }, - "SourceAddresses": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourcePortRanges": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.PortRange" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisRouteTableRoute": { - "additionalProperties": false, - "properties": { - "NatGatewayId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "Origin": { - "type": "string" - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcPeeringConnectionId": { - "type": "string" - }, - "destinationCidr": { - "type": "string" - }, - "destinationPrefixListId": { - "type": "string" - }, - "egressOnlyInternetGatewayId": { - "type": "string" - }, - "gatewayId": { - "type": "string" - }, - "instanceId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.AnalysisSecurityGroupRule": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Direction": { - "type": "string" - }, - "PortRange": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.PortRange" - }, - "PrefixListId": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "SecurityGroupId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.Explanation": { - "additionalProperties": false, - "properties": { - "Acl": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "AclRule": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisAclRule" - }, - "Address": { - "type": "string" - }, - "Addresses": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AttachedTo": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Cidrs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClassicLoadBalancerListener": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerListener" - }, - "Component": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "CustomerGateway": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Destination": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "DestinationVpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Direction": { - "type": "string" - }, - "ElasticLoadBalancerListener": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "ExplanationCode": { - "type": "string" - }, - "IngressRouteTable": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "InternetGateway": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "LoadBalancerArn": { - "type": "string" - }, - "LoadBalancerListenerPort": { - "type": "number" - }, - "LoadBalancerTarget": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisLoadBalancerTarget" - }, - "LoadBalancerTargetGroup": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "LoadBalancerTargetGroups": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "type": "array" - }, - "LoadBalancerTargetPort": { - "type": "number" - }, - "MissingComponent": { - "type": "string" - }, - "NatGateway": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "NetworkInterface": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "PacketField": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PortRanges": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.PortRange" - }, - "type": "array" - }, - "PrefixList": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Protocols": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RouteTable": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "RouteTableRoute": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisRouteTableRoute" - }, - "SecurityGroup": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "SecurityGroupRule": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisSecurityGroupRule" - }, - "SecurityGroups": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "type": "array" - }, - "SourceVpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "State": { - "type": "string" - }, - "Subnet": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "SubnetRouteTable": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Vpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "VpcPeeringConnection": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "VpnConnection": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "VpnGateway": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "vpcEndpoint": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.PathComponent": { - "additionalProperties": false, - "properties": { - "AclRule": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisAclRule" - }, - "Component": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "DestinationVpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "InboundHeader": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisPacketHeader" - }, - "OutboundHeader": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisPacketHeader" - }, - "RouteTableRoute": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisRouteTableRoute" - }, - "SecurityGroupRule": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisSecurityGroupRule" - }, - "SequenceNumber": { - "type": "number" - }, - "SourceVpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Subnet": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - }, - "Vpc": { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsAnalysis.PortRange": { - "additionalProperties": false, - "properties": { - "From": { - "type": "number" - }, - "To": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::NetworkInsightsPath": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - }, - "DestinationIp": { - "type": "string" - }, - "DestinationPort": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "SourceIp": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Destination", - "Protocol", - "Source" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkInsightsPath" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkInterface": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GroupSet": { - "items": { - "type": "string" - }, - "type": "array" - }, - "InterfaceType": { - "type": "string" - }, - "Ipv6AddressCount": { - "type": "number" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInterface.InstanceIpv6Address" - }, - "type": "array" - }, - "PrivateIpAddress": { - "type": "string" - }, - "PrivateIpAddresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::NetworkInterface.PrivateIpAddressSpecification" - }, - "type": "array" - }, - "SecondaryPrivateIpAddressCount": { - "type": "number" - }, - "SourceDestCheck": { - "type": "boolean" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkInterface" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkInterface.InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "AWS::EC2::NetworkInterface.PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "required": [ - "Primary", - "PrivateIpAddress" - ], - "type": "object" - }, - "AWS::EC2::NetworkInterfaceAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "DeviceIndex": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - } - }, - "required": [ - "DeviceIndex", - "InstanceId", - "NetworkInterfaceId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkInterfaceAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::NetworkInterfacePermission": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "Permission": { - "type": "string" - } - }, - "required": [ - "AwsAccountId", - "NetworkInterfaceId", - "Permission" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::NetworkInterfacePermission" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::PlacementGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Strategy": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::PlacementGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::PrefixList": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AddressFamily": { - "type": "string" - }, - "Entries": { - "items": { - "$ref": "#/definitions/AWS::EC2::PrefixList.Entry" - }, - "type": "array" - }, - "MaxEntries": { - "type": "number" - }, - "PrefixListName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AddressFamily", - "MaxEntries", - "PrefixListName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::PrefixList" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::PrefixList.Entry": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Description": { - "type": "string" - } - }, - "required": [ - "Cidr" - ], - "type": "object" - }, - "AWS::EC2::Route": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CarrierGatewayId": { - "type": "string" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "DestinationIpv6CidrBlock": { - "type": "string" - }, - "EgressOnlyInternetGatewayId": { - "type": "string" - }, - "GatewayId": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "LocalGatewayId": { - "type": "string" - }, - "NatGatewayId": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "RouteTableId": { - "type": "string" - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcEndpointId": { - "type": "string" - }, - "VpcPeeringConnectionId": { - "type": "string" - } - }, - "required": [ - "RouteTableId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::Route" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::RouteTable": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::RouteTable" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SecurityGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupDescription": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "SecurityGroupEgress": { - "items": { - "$ref": "#/definitions/AWS::EC2::SecurityGroup.Egress" - }, - "type": "array" - }, - "SecurityGroupIngress": { - "items": { - "$ref": "#/definitions/AWS::EC2::SecurityGroup.Ingress" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "GroupDescription" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SecurityGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SecurityGroup.Egress": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DestinationPrefixListId": { - "type": "string" - }, - "DestinationSecurityGroupId": { - "type": "string" - }, - "FromPort": { - "type": "number" - }, - "IpProtocol": { - "type": "string" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "IpProtocol" - ], - "type": "object" - }, - "AWS::EC2::SecurityGroup.Ingress": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FromPort": { - "type": "number" - }, - "IpProtocol": { - "type": "string" - }, - "SourcePrefixListId": { - "type": "string" - }, - "SourceSecurityGroupId": { - "type": "string" - }, - "SourceSecurityGroupName": { - "type": "string" - }, - "SourceSecurityGroupOwnerId": { - "type": "string" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "IpProtocol" - ], - "type": "object" - }, - "AWS::EC2::SecurityGroupEgress": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DestinationPrefixListId": { - "type": "string" - }, - "DestinationSecurityGroupId": { - "type": "string" - }, - "FromPort": { - "type": "number" - }, - "GroupId": { - "type": "string" - }, - "IpProtocol": { - "type": "string" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "GroupId", - "IpProtocol" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SecurityGroupEgress" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SecurityGroupIngress": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CidrIp": { - "type": "string" - }, - "CidrIpv6": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FromPort": { - "type": "number" - }, - "GroupId": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "IpProtocol": { - "type": "string" - }, - "SourcePrefixListId": { - "type": "string" - }, - "SourceSecurityGroupId": { - "type": "string" - }, - "SourceSecurityGroupName": { - "type": "string" - }, - "SourceSecurityGroupOwnerId": { - "type": "string" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "IpProtocol" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SecurityGroupIngress" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SpotFleetRequestConfigData": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotFleetRequestConfigData" - } - }, - "required": [ - "SpotFleetRequestConfigData" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SpotFleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.EbsBlockDevice" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.ClassicLoadBalancer": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.ClassicLoadBalancersConfig": { - "additionalProperties": false, - "properties": { - "ClassicLoadBalancers": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.ClassicLoadBalancer" - }, - "type": "array" - } - }, - "required": [ - "ClassicLoadBalancers" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.EbsBlockDevice": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Version" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.GroupIdentifier": { - "additionalProperties": false, - "properties": { - "GroupId": { - "type": "string" - } - }, - "required": [ - "GroupId" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.IamInstanceProfileSpecification": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.InstanceIpv6Address": { - "additionalProperties": false, - "properties": { - "Ipv6Address": { - "type": "string" - } - }, - "required": [ - "Ipv6Address" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification": { - "additionalProperties": false, - "properties": { - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "DeleteOnTermination": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DeviceIndex": { - "type": "number" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Ipv6AddressCount": { - "type": "number" - }, - "Ipv6Addresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.InstanceIpv6Address" - }, - "type": "array" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PrivateIpAddresses": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.PrivateIpAddressSpecification" - }, - "type": "array" - }, - "SecondaryPrivateIpAddressCount": { - "type": "number" - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.LaunchTemplateConfig": { - "additionalProperties": false, - "properties": { - "LaunchTemplateSpecification": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.FleetLaunchTemplateSpecification" - }, - "Overrides": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.LaunchTemplateOverrides" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.LaunchTemplateOverrides": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "SpotPrice": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.LoadBalancersConfig": { - "additionalProperties": false, - "properties": { - "ClassicLoadBalancersConfig": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.ClassicLoadBalancersConfig" - }, - "TargetGroupsConfig": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.TargetGroupsConfig" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.PrivateIpAddressSpecification": { - "additionalProperties": false, - "properties": { - "Primary": { - "type": "boolean" - }, - "PrivateIpAddress": { - "type": "string" - } - }, - "required": [ - "PrivateIpAddress" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotCapacityRebalance": { - "additionalProperties": false, - "properties": { - "ReplacementStrategy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotFleetLaunchSpecification": { - "additionalProperties": false, - "properties": { - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.BlockDeviceMapping" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - }, - "IamInstanceProfile": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.IamInstanceProfileSpecification" - }, - "ImageId": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "KernelId": { - "type": "string" - }, - "KeyName": { - "type": "string" - }, - "Monitoring": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotFleetMonitoring" - }, - "NetworkInterfaces": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.InstanceNetworkInterfaceSpecification" - }, - "type": "array" - }, - "Placement": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotPlacement" - }, - "RamdiskId": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.GroupIdentifier" - }, - "type": "array" - }, - "SpotPrice": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "TagSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotFleetTagSpecification" - }, - "type": "array" - }, - "UserData": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "required": [ - "ImageId", - "InstanceType" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotFleetMonitoring": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotFleetRequestConfigData": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "ExcessCapacityTerminationPolicy": { - "type": "string" - }, - "IamFleetRole": { - "type": "string" - }, - "InstanceInterruptionBehavior": { - "type": "string" - }, - "InstancePoolsToUseCount": { - "type": "number" - }, - "LaunchSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotFleetLaunchSpecification" - }, - "type": "array" - }, - "LaunchTemplateConfigs": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.LaunchTemplateConfig" - }, - "type": "array" - }, - "LoadBalancersConfig": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.LoadBalancersConfig" - }, - "OnDemandAllocationStrategy": { - "type": "string" - }, - "OnDemandMaxTotalPrice": { - "type": "string" - }, - "OnDemandTargetCapacity": { - "type": "number" - }, - "ReplaceUnhealthyInstances": { - "type": "boolean" - }, - "SpotMaintenanceStrategies": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotMaintenanceStrategies" - }, - "SpotMaxTotalPrice": { - "type": "string" - }, - "SpotPrice": { - "type": "string" - }, - "TargetCapacity": { - "type": "number" - }, - "TerminateInstancesWithExpiration": { - "type": "boolean" - }, - "Type": { - "type": "string" - }, - "ValidFrom": { - "type": "string" - }, - "ValidUntil": { - "type": "string" - } - }, - "required": [ - "IamFleetRole", - "TargetCapacity" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotFleetTagSpecification": { - "additionalProperties": false, - "properties": { - "ResourceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotMaintenanceStrategies": { - "additionalProperties": false, - "properties": { - "CapacityRebalance": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.SpotCapacityRebalance" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.SpotPlacement": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "GroupName": { - "type": "string" - }, - "Tenancy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::SpotFleet.TargetGroup": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::EC2::SpotFleet.TargetGroupsConfig": { - "additionalProperties": false, - "properties": { - "TargetGroups": { - "items": { - "$ref": "#/definitions/AWS::EC2::SpotFleet.TargetGroup" - }, - "type": "array" - } - }, - "required": [ - "TargetGroups" - ], - "type": "object" - }, - "AWS::EC2::Subnet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssignIpv6AddressOnCreation": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "CidrBlock": { - "type": "string" - }, - "Ipv6CidrBlock": { - "type": "string" - }, - "MapPublicIpOnLaunch": { - "type": "boolean" - }, - "OutpostArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "CidrBlock", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::Subnet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SubnetCidrBlock": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Ipv6CidrBlock": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "Ipv6CidrBlock", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SubnetCidrBlock" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SubnetNetworkAclAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "NetworkAclId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "NetworkAclId", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SubnetNetworkAclAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::SubnetRouteTableAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RouteTableId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "RouteTableId", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::SubnetRouteTableAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TrafficMirrorFilter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "NetworkServices": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TrafficMirrorFilter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::TrafficMirrorFilterRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "DestinationPortRange": { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange" - }, - "Protocol": { - "type": "number" - }, - "RuleAction": { - "type": "string" - }, - "RuleNumber": { - "type": "number" - }, - "SourceCidrBlock": { - "type": "string" - }, - "SourcePortRange": { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange" - }, - "TrafficDirection": { - "type": "string" - }, - "TrafficMirrorFilterId": { - "type": "string" - } - }, - "required": [ - "DestinationCidrBlock", - "RuleAction", - "RuleNumber", - "SourceCidrBlock", - "TrafficDirection", - "TrafficMirrorFilterId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TrafficMirrorFilterRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TrafficMirrorFilterRule.TrafficMirrorPortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "number" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "AWS::EC2::TrafficMirrorSession": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "PacketLength": { - "type": "number" - }, - "SessionNumber": { - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TrafficMirrorFilterId": { - "type": "string" - }, - "TrafficMirrorTargetId": { - "type": "string" - }, - "VirtualNetworkId": { - "type": "number" - } - }, - "required": [ - "NetworkInterfaceId", - "SessionNumber", - "TrafficMirrorFilterId", - "TrafficMirrorTargetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TrafficMirrorSession" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TrafficMirrorTarget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "NetworkLoadBalancerArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TrafficMirrorTarget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::TransitGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AmazonSideAsn": { - "type": "number" - }, - "AutoAcceptSharedAttachments": { - "type": "string" - }, - "DefaultRouteTableAssociation": { - "type": "string" - }, - "DefaultRouteTablePropagation": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DnsSupport": { - "type": "string" - }, - "MulticastSupport": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpnEcmpSupport": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "SubnetIds", - "TransitGatewayId", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayConnect": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Options": { - "$ref": "#/definitions/AWS::EC2::TransitGatewayConnect.TransitGatewayConnectOptions" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransportTransitGatewayAttachmentId": { - "type": "string" - } - }, - "required": [ - "Options", - "TransportTransitGatewayAttachmentId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayConnect" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayConnect.TransitGatewayConnectOptions": { - "additionalProperties": false, - "properties": { - "Protocol": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::TransitGatewayMulticastDomain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Options": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "type": "string" - } - }, - "required": [ - "TransitGatewayId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayMulticastDomain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayMulticastDomainAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SubnetId": { - "type": "string" - }, - "TransitGatewayAttachmentId": { - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "type": "string" - } - }, - "required": [ - "SubnetId", - "TransitGatewayAttachmentId", - "TransitGatewayMulticastDomainId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayMulticastDomainAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayMulticastGroupMember": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupIpAddress": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "type": "string" - } - }, - "required": [ - "GroupIpAddress", - "NetworkInterfaceId", - "TransitGatewayMulticastDomainId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayMulticastGroupMember" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayMulticastGroupSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupIpAddress": { - "type": "string" - }, - "NetworkInterfaceId": { - "type": "string" - }, - "TransitGatewayMulticastDomainId": { - "type": "string" - } - }, - "required": [ - "GroupIpAddress", - "NetworkInterfaceId", - "TransitGatewayMulticastDomainId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayMulticastGroupSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayRoute": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Blackhole": { - "type": "boolean" - }, - "DestinationCidrBlock": { - "type": "string" - }, - "TransitGatewayAttachmentId": { - "type": "string" - }, - "TransitGatewayRouteTableId": { - "type": "string" - } - }, - "required": [ - "TransitGatewayRouteTableId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayRoute" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayRouteTable": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "type": "string" - } - }, - "required": [ - "TransitGatewayId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayRouteTable" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayRouteTableAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "TransitGatewayAttachmentId": { - "type": "string" - }, - "TransitGatewayRouteTableId": { - "type": "string" - } - }, - "required": [ - "TransitGatewayAttachmentId", - "TransitGatewayRouteTableId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayRouteTableAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::TransitGatewayRouteTablePropagation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "TransitGatewayAttachmentId": { - "type": "string" - }, - "TransitGatewayRouteTableId": { - "type": "string" - } - }, - "required": [ - "TransitGatewayAttachmentId", - "TransitGatewayRouteTableId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::TransitGatewayRouteTablePropagation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPC": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CidrBlock": { - "type": "string" - }, - "EnableDnsHostnames": { - "type": "boolean" - }, - "EnableDnsSupport": { - "type": "boolean" - }, - "InstanceTenancy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "CidrBlock" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPC" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCCidrBlock": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AmazonProvidedIpv6CidrBlock": { - "type": "boolean" - }, - "CidrBlock": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCCidrBlock" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCDHCPOptionsAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DhcpOptionsId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "DhcpOptionsId", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCDHCPOptionsAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "PrivateDnsEnabled": { - "type": "boolean" - }, - "RouteTableIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ServiceName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcEndpointType": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "ServiceName", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCEndpointConnectionNotification": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ConnectionNotificationArn": { - "type": "string" - }, - "ServiceId": { - "type": "string" - }, - "VPCEndpointId": { - "type": "string" - } - }, - "required": [ - "ConnectionEvents", - "ConnectionNotificationArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCEndpointConnectionNotification" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCEndpointService": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptanceRequired": { - "type": "boolean" - }, - "GatewayLoadBalancerArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "NetworkLoadBalancerArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCEndpointService" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EC2::VPCEndpointServicePermissions": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowedPrincipals": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ServiceId": { - "type": "string" - } - }, - "required": [ - "ServiceId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCEndpointServicePermissions" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCGatewayAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InternetGatewayId": { - "type": "string" - }, - "VpcId": { - "type": "string" - }, - "VpnGatewayId": { - "type": "string" - } - }, - "required": [ - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCGatewayAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPCPeeringConnection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PeerOwnerId": { - "type": "string" - }, - "PeerRegion": { - "type": "string" - }, - "PeerRoleArn": { - "type": "string" - }, - "PeerVpcId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "PeerVpcId", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPCPeeringConnection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPNConnection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CustomerGatewayId": { - "type": "string" - }, - "StaticRoutesOnly": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitGatewayId": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "VpnGatewayId": { - "type": "string" - }, - "VpnTunnelOptionsSpecifications": { - "items": { - "$ref": "#/definitions/AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification" - }, - "type": "array" - } - }, - "required": [ - "CustomerGatewayId", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPNConnection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification": { - "additionalProperties": false, - "properties": { - "PreSharedKey": { - "type": "string" - }, - "TunnelInsideCidr": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EC2::VPNConnectionRoute": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationCidrBlock": { - "type": "string" - }, - "VpnConnectionId": { - "type": "string" - } - }, - "required": [ - "DestinationCidrBlock", - "VpnConnectionId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPNConnectionRoute" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPNGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AmazonSideAsn": { - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPNGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VPNGatewayRoutePropagation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RouteTableIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpnGatewayId": { - "type": "string" - } - }, - "required": [ - "RouteTableIds", - "VpnGatewayId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VPNGatewayRoutePropagation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::Volume": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoEnableIO": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - }, - "MultiAttachEnabled": { - "type": "boolean" - }, - "OutpostArn": { - "type": "string" - }, - "Size": { - "type": "number" - }, - "SnapshotId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Throughput": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::Volume" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EC2::VolumeAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Device": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "VolumeId": { - "type": "string" - } - }, - "required": [ - "Device", - "InstanceId", - "VolumeId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EC2::VolumeAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECR::PublicRepository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RepositoryCatalogData": { - "type": "object" - }, - "RepositoryName": { - "type": "string" - }, - "RepositoryPolicyText": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECR::PublicRepository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECR::RegistryPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyText": { - "type": "object" - } - }, - "required": [ - "PolicyText" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECR::RegistryPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECR::ReplicationConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ReplicationConfiguration": { - "$ref": "#/definitions/AWS::ECR::ReplicationConfiguration.ReplicationConfiguration" - } - }, - "required": [ - "ReplicationConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECR::ReplicationConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECR::ReplicationConfiguration.ReplicationConfiguration": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::ECR::ReplicationConfiguration.ReplicationRule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::ECR::ReplicationConfiguration.ReplicationDestination": { - "additionalProperties": false, - "properties": { - "Region": { - "type": "string" - }, - "RegistryId": { - "type": "string" - } - }, - "required": [ - "Region", - "RegistryId" - ], - "type": "object" - }, - "AWS::ECR::ReplicationConfiguration.ReplicationRule": { - "additionalProperties": false, - "properties": { - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::ECR::ReplicationConfiguration.ReplicationDestination" - }, - "type": "array" - } - }, - "required": [ - "Destinations" - ], - "type": "object" - }, - "AWS::ECR::Repository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ImageScanningConfiguration": { - "type": "object" - }, - "ImageTagMutability": { - "type": "string" - }, - "LifecyclePolicy": { - "$ref": "#/definitions/AWS::ECR::Repository.LifecyclePolicy" - }, - "RepositoryName": { - "type": "string" - }, - "RepositoryPolicyText": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECR::Repository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECR::Repository.LifecyclePolicy": { - "additionalProperties": false, - "properties": { - "LifecyclePolicyText": { - "type": "string" - }, - "RegistryId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::CapacityProvider": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupProvider": { - "$ref": "#/definitions/AWS::ECS::CapacityProvider.AutoScalingGroupProvider" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AutoScalingGroupProvider" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::CapacityProvider" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECS::CapacityProvider.AutoScalingGroupProvider": { - "additionalProperties": false, - "properties": { - "AutoScalingGroupArn": { - "type": "string" - }, - "ManagedScaling": { - "$ref": "#/definitions/AWS::ECS::CapacityProvider.ManagedScaling" - }, - "ManagedTerminationProtection": { - "type": "string" - } - }, - "required": [ - "AutoScalingGroupArn" - ], - "type": "object" - }, - "AWS::ECS::CapacityProvider.ManagedScaling": { - "additionalProperties": false, - "properties": { - "MaximumScalingStepSize": { - "type": "number" - }, - "MinimumScalingStepSize": { - "type": "number" - }, - "Status": { - "type": "string" - }, - "TargetCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CapacityProviders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClusterName": { - "type": "string" - }, - "ClusterSettings": { - "items": { - "$ref": "#/definitions/AWS::ECS::Cluster.ClusterSettings" - }, - "type": "array" - }, - "Configuration": { - "$ref": "#/definitions/AWS::ECS::Cluster.ClusterConfiguration" - }, - "DefaultCapacityProviderStrategy": { - "items": { - "$ref": "#/definitions/AWS::ECS::Cluster.CapacityProviderStrategyItem" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::Cluster.CapacityProviderStrategyItem": { - "additionalProperties": false, - "properties": { - "Base": { - "type": "number" - }, - "CapacityProvider": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::Cluster.ClusterConfiguration": { - "additionalProperties": false, - "properties": { - "ExecuteCommandConfiguration": { - "$ref": "#/definitions/AWS::ECS::Cluster.ExecuteCommandConfiguration" - } - }, - "type": "object" - }, - "AWS::ECS::Cluster.ClusterSettings": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::Cluster.ExecuteCommandConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "LogConfiguration": { - "$ref": "#/definitions/AWS::ECS::Cluster.ExecuteCommandLogConfiguration" - }, - "Logging": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::Cluster.ExecuteCommandLogConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchEncryptionEnabled": { - "type": "boolean" - }, - "CloudWatchLogGroupName": { - "type": "string" - }, - "S3BucketName": { - "type": "string" - }, - "S3EncryptionEnabled": { - "type": "boolean" - }, - "S3KeyPrefix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::ClusterCapacityProviderAssociations": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CapacityProviders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Cluster": { - "type": "string" - }, - "DefaultCapacityProviderStrategy": { - "items": { - "$ref": "#/definitions/AWS::ECS::ClusterCapacityProviderAssociations.CapacityProviderStrategy" - }, - "type": "array" - } - }, - "required": [ - "CapacityProviders", - "Cluster", - "DefaultCapacityProviderStrategy" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::ClusterCapacityProviderAssociations" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECS::ClusterCapacityProviderAssociations.CapacityProviderStrategy": { - "additionalProperties": false, - "properties": { - "Base": { - "type": "number" - }, - "CapacityProvider": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "required": [ - "CapacityProvider" - ], - "type": "object" - }, - "AWS::ECS::PrimaryTaskSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Cluster": { - "type": "string" - }, - "Service": { - "type": "string" - }, - "TaskSetId": { - "type": "string" - } - }, - "required": [ - "Cluster", - "Service", - "TaskSetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::PrimaryTaskSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECS::Service": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CapacityProviderStrategy": { - "items": { - "$ref": "#/definitions/AWS::ECS::Service.CapacityProviderStrategyItem" - }, - "type": "array" - }, - "Cluster": { - "type": "string" - }, - "DeploymentConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.DeploymentConfiguration" - }, - "DeploymentController": { - "$ref": "#/definitions/AWS::ECS::Service.DeploymentController" - }, - "DesiredCount": { - "type": "number" - }, - "EnableECSManagedTags": { - "type": "boolean" - }, - "EnableExecuteCommand": { - "type": "boolean" - }, - "HealthCheckGracePeriodSeconds": { - "type": "number" - }, - "LaunchType": { - "type": "string" - }, - "LoadBalancers": { - "items": { - "$ref": "#/definitions/AWS::ECS::Service.LoadBalancer" - }, - "type": "array" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.NetworkConfiguration" - }, - "PlacementConstraints": { - "items": { - "$ref": "#/definitions/AWS::ECS::Service.PlacementConstraint" - }, - "type": "array" - }, - "PlacementStrategies": { - "items": { - "$ref": "#/definitions/AWS::ECS::Service.PlacementStrategy" - }, - "type": "array" - }, - "PlatformVersion": { - "type": "string" - }, - "PropagateTags": { - "type": "string" - }, - "Role": { - "type": "string" - }, - "SchedulingStrategy": { - "type": "string" - }, - "ServiceArn": { - "type": "string" - }, - "ServiceName": { - "type": "string" - }, - "ServiceRegistries": { - "items": { - "$ref": "#/definitions/AWS::ECS::Service.ServiceRegistry" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskDefinition": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::Service" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::Service.AwsVpcConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ECS::Service.CapacityProviderStrategyItem": { - "additionalProperties": false, - "properties": { - "Base": { - "type": "number" - }, - "CapacityProvider": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::Service.DeploymentCircuitBreaker": { - "additionalProperties": false, - "properties": { - "Enable": { - "type": "boolean" - }, - "Rollback": { - "type": "boolean" - } - }, - "required": [ - "Enable", - "Rollback" - ], - "type": "object" - }, - "AWS::ECS::Service.DeploymentConfiguration": { - "additionalProperties": false, - "properties": { - "DeploymentCircuitBreaker": { - "$ref": "#/definitions/AWS::ECS::Service.DeploymentCircuitBreaker" - }, - "MaximumPercent": { - "type": "number" - }, - "MinimumHealthyPercent": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::Service.DeploymentController": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::Service.LoadBalancer": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "type": "string" - }, - "ContainerPort": { - "type": "number" - }, - "LoadBalancerName": { - "type": "string" - }, - "TargetGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::Service.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AwsvpcConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.AwsVpcConfiguration" - } - }, - "type": "object" - }, - "AWS::ECS::Service.PlacementConstraint": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::Service.PlacementStrategy": { - "additionalProperties": false, - "properties": { - "Field": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::Service.ServiceRegistry": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "type": "string" - }, - "ContainerPort": { - "type": "number" - }, - "Port": { - "type": "number" - }, - "RegistryArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContainerDefinitions": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDefinition" - }, - "type": "array" - }, - "Cpu": { - "type": "string" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "InferenceAccelerators": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.InferenceAccelerator" - }, - "type": "array" - }, - "IpcMode": { - "type": "string" - }, - "Memory": { - "type": "string" - }, - "NetworkMode": { - "type": "string" - }, - "PidMode": { - "type": "string" - }, - "PlacementConstraints": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint" - }, - "type": "array" - }, - "ProxyConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.ProxyConfiguration" - }, - "RequiresCompatibilities": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TaskRoleArn": { - "type": "string" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Volume" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::TaskDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.AuthorizationConfig": { - "additionalProperties": false, - "properties": { - "AccessPointId": { - "type": "string" - }, - "IAM": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.ContainerDefinition": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Cpu": { - "type": "number" - }, - "DependsOn": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDependency" - }, - "type": "array" - }, - "DisableNetworking": { - "type": "boolean" - }, - "DnsSearchDomains": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DnsServers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DockerLabels": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "DockerSecurityOptions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EntryPoint": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" - }, - "type": "array" - }, - "EnvironmentFiles": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.EnvironmentFile" - }, - "type": "array" - }, - "Essential": { - "type": "boolean" - }, - "ExtraHosts": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostEntry" - }, - "type": "array" - }, - "FirelensConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.FirelensConfiguration" - }, - "HealthCheck": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.HealthCheck" - }, - "Hostname": { - "type": "string" - }, - "Image": { - "type": "string" - }, - "Interactive": { - "type": "boolean" - }, - "Links": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LinuxParameters": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.LinuxParameters" - }, - "LogConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.LogConfiguration" - }, - "Memory": { - "type": "number" - }, - "MemoryReservation": { - "type": "number" - }, - "MountPoints": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.MountPoint" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "PortMappings": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.PortMapping" - }, - "type": "array" - }, - "Privileged": { - "type": "boolean" - }, - "PseudoTerminal": { - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "type": "boolean" - }, - "RepositoryCredentials": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.RepositoryCredentials" - }, - "ResourceRequirements": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.ResourceRequirement" - }, - "type": "array" - }, - "Secrets": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Secret" - }, - "type": "array" - }, - "StartTimeout": { - "type": "number" - }, - "StopTimeout": { - "type": "number" - }, - "SystemControls": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.SystemControl" - }, - "type": "array" - }, - "Ulimits": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Ulimit" - }, - "type": "array" - }, - "User": { - "type": "string" - }, - "VolumesFrom": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.VolumeFrom" - }, - "type": "array" - }, - "WorkingDirectory": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.ContainerDependency": { - "additionalProperties": false, - "properties": { - "Condition": { - "type": "string" - }, - "ContainerName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.Device": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "HostPath": { - "type": "string" - }, - "Permissions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.DockerVolumeConfiguration": { - "additionalProperties": false, - "properties": { - "Autoprovision": { - "type": "boolean" - }, - "Driver": { - "type": "string" - }, - "DriverOpts": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Labels": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Scope": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.EFSVolumeConfiguration": { - "additionalProperties": false, - "properties": { - "AuthorizationConfig": { - "type": "object" - }, - "FilesystemId": { - "type": "string" - }, - "RootDirectory": { - "type": "string" - }, - "TransitEncryption": { - "type": "string" - }, - "TransitEncryptionPort": { - "type": "number" - } - }, - "required": [ - "FilesystemId" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.EnvironmentFile": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.FirelensConfiguration": { - "additionalProperties": false, - "properties": { - "Options": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.HealthCheck": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Interval": { - "type": "number" - }, - "Retries": { - "type": "number" - }, - "StartPeriod": { - "type": "number" - }, - "Timeout": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.HostEntry": { - "additionalProperties": false, - "properties": { - "Hostname": { - "type": "string" - }, - "IpAddress": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.HostVolumeProperties": { - "additionalProperties": false, - "properties": { - "SourcePath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.InferenceAccelerator": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "DeviceType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.KernelCapabilities": { - "additionalProperties": false, - "properties": { - "Add": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Drop": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.KeyValuePair": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.LinuxParameters": { - "additionalProperties": false, - "properties": { - "Capabilities": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.KernelCapabilities" - }, - "Devices": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Device" - }, - "type": "array" - }, - "InitProcessEnabled": { - "type": "boolean" - }, - "MaxSwap": { - "type": "number" - }, - "SharedMemorySize": { - "type": "number" - }, - "Swappiness": { - "type": "number" - }, - "Tmpfs": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Tmpfs" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogDriver": { - "type": "string" - }, - "Options": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "SecretOptions": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.Secret" - }, - "type": "array" - } - }, - "required": [ - "LogDriver" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.MountPoint": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "SourceVolume": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.PortMapping": { - "additionalProperties": false, - "properties": { - "ContainerPort": { - "type": "number" - }, - "HostPort": { - "type": "number" - }, - "Protocol": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.ProxyConfiguration": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "type": "string" - }, - "ProxyConfigurationProperties": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "ContainerName" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.RepositoryCredentials": { - "additionalProperties": false, - "properties": { - "CredentialsParameter": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.ResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.Secret": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ValueFrom": { - "type": "string" - } - }, - "required": [ - "Name", - "ValueFrom" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.SystemControl": { - "additionalProperties": false, - "properties": { - "Namespace": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.TaskDefinitionPlacementConstraint": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.Tmpfs": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "MountOptions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Size": { - "type": "number" - } - }, - "required": [ - "Size" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.Ulimit": { - "additionalProperties": false, - "properties": { - "HardLimit": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "SoftLimit": { - "type": "number" - } - }, - "required": [ - "HardLimit", - "Name", - "SoftLimit" - ], - "type": "object" - }, - "AWS::ECS::TaskDefinition.Volume": { - "additionalProperties": false, - "properties": { - "DockerVolumeConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.DockerVolumeConfiguration" - }, - "EFSVolumeConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.EFSVolumeConfiguration" - }, - "Host": { - "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostVolumeProperties" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskDefinition.VolumeFrom": { - "additionalProperties": false, - "properties": { - "ReadOnly": { - "type": "boolean" - }, - "SourceContainer": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Cluster": { - "type": "string" - }, - "ExternalId": { - "type": "string" - }, - "LaunchType": { - "type": "string" - }, - "LoadBalancers": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskSet.LoadBalancer" - }, - "type": "array" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskSet.NetworkConfiguration" - }, - "PlatformVersion": { - "type": "string" - }, - "Scale": { - "$ref": "#/definitions/AWS::ECS::TaskSet.Scale" - }, - "Service": { - "type": "string" - }, - "ServiceRegistries": { - "items": { - "$ref": "#/definitions/AWS::ECS::TaskSet.ServiceRegistry" - }, - "type": "array" - }, - "TaskDefinition": { - "type": "string" - } - }, - "required": [ - "Cluster", - "Service", - "TaskDefinition" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ECS::TaskSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ECS::TaskSet.AwsVpcConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Subnets" - ], - "type": "object" - }, - "AWS::ECS::TaskSet.LoadBalancer": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "type": "string" - }, - "ContainerPort": { - "type": "number" - }, - "LoadBalancerName": { - "type": "string" - }, - "TargetGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ECS::TaskSet.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AwsVpcConfiguration": { - "$ref": "#/definitions/AWS::ECS::TaskSet.AwsVpcConfiguration" - } - }, - "type": "object" - }, - "AWS::ECS::TaskSet.Scale": { - "additionalProperties": false, - "properties": { - "Unit": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ECS::TaskSet.ServiceRegistry": { - "additionalProperties": false, - "properties": { - "ContainerName": { - "type": "string" - }, - "ContainerPort": { - "type": "number" - }, - "Port": { - "type": "number" - }, - "RegistryArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EFS::AccessPoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessPointTags": { - "items": { - "$ref": "#/definitions/AWS::EFS::AccessPoint.AccessPointTag" - }, - "type": "array" - }, - "ClientToken": { - "type": "string" - }, - "FileSystemId": { - "type": "string" - }, - "PosixUser": { - "$ref": "#/definitions/AWS::EFS::AccessPoint.PosixUser" - }, - "RootDirectory": { - "$ref": "#/definitions/AWS::EFS::AccessPoint.RootDirectory" - } - }, - "required": [ - "FileSystemId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EFS::AccessPoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EFS::AccessPoint.AccessPointTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EFS::AccessPoint.CreationInfo": { - "additionalProperties": false, - "properties": { - "OwnerGid": { - "type": "string" - }, - "OwnerUid": { - "type": "string" - }, - "Permissions": { - "type": "string" - } - }, - "required": [ - "OwnerGid", - "OwnerUid", - "Permissions" - ], - "type": "object" - }, - "AWS::EFS::AccessPoint.PosixUser": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "string" - }, - "SecondaryGids": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Uid": { - "type": "string" - } - }, - "required": [ - "Gid", - "Uid" - ], - "type": "object" - }, - "AWS::EFS::AccessPoint.RootDirectory": { - "additionalProperties": false, - "properties": { - "CreationInfo": { - "$ref": "#/definitions/AWS::EFS::AccessPoint.CreationInfo" - }, - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EFS::FileSystem": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AvailabilityZoneName": { - "type": "string" - }, - "BackupPolicy": { - "$ref": "#/definitions/AWS::EFS::FileSystem.BackupPolicy" - }, - "Encrypted": { - "type": "boolean" - }, - "FileSystemPolicy": { - "type": "object" - }, - "FileSystemTags": { - "items": { - "$ref": "#/definitions/AWS::EFS::FileSystem.ElasticFileSystemTag" - }, - "type": "array" - }, - "KmsKeyId": { - "type": "string" - }, - "LifecyclePolicies": { - "items": { - "$ref": "#/definitions/AWS::EFS::FileSystem.LifecyclePolicy" - }, - "type": "array" - }, - "PerformanceMode": { - "type": "string" - }, - "ProvisionedThroughputInMibps": { - "type": "number" - }, - "ThroughputMode": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EFS::FileSystem" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EFS::FileSystem.BackupPolicy": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::EFS::FileSystem.ElasticFileSystemTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EFS::FileSystem.LifecyclePolicy": { - "additionalProperties": false, - "properties": { - "TransitionToIA": { - "type": "string" - } - }, - "required": [ - "TransitionToIA" - ], - "type": "object" - }, - "AWS::EFS::MountTarget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FileSystemId": { - "type": "string" - }, - "IpAddress": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "FileSystemId", - "SecurityGroups", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EFS::MountTarget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EKS::Addon": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AddonName": { - "type": "string" - }, - "AddonVersion": { - "type": "string" - }, - "ClusterName": { - "type": "string" - }, - "ResolveConflicts": { - "type": "string" - }, - "ServiceAccountRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AddonName", - "ClusterName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EKS::Addon" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EKS::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EncryptionConfig": { - "items": { - "$ref": "#/definitions/AWS::EKS::Cluster.EncryptionConfig" - }, - "type": "array" - }, - "KubernetesNetworkConfig": { - "$ref": "#/definitions/AWS::EKS::Cluster.KubernetesNetworkConfig" - }, - "Name": { - "type": "string" - }, - "ResourcesVpcConfig": { - "$ref": "#/definitions/AWS::EKS::Cluster.ResourcesVpcConfig" - }, - "RoleArn": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "ResourcesVpcConfig", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EKS::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EKS::Cluster.EncryptionConfig": { - "additionalProperties": false, - "properties": { - "Provider": { - "$ref": "#/definitions/AWS::EKS::Cluster.Provider" - }, - "Resources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EKS::Cluster.KubernetesNetworkConfig": { - "additionalProperties": false, - "properties": { - "ServiceIpv4Cidr": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EKS::Cluster.Provider": { - "additionalProperties": false, - "properties": { - "KeyArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EKS::Cluster.ResourcesVpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SubnetIds" - ], - "type": "object" - }, - "AWS::EKS::FargateProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClusterName": { - "type": "string" - }, - "FargateProfileName": { - "type": "string" - }, - "PodExecutionRoleArn": { - "type": "string" - }, - "Selectors": { - "items": { - "$ref": "#/definitions/AWS::EKS::FargateProfile.Selector" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ClusterName", - "PodExecutionRoleArn", - "Selectors" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EKS::FargateProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EKS::FargateProfile.Label": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EKS::FargateProfile.Selector": { - "additionalProperties": false, - "properties": { - "Labels": { - "items": { - "$ref": "#/definitions/AWS::EKS::FargateProfile.Label" - }, - "type": "array" - }, - "Namespace": { - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "AWS::EKS::Nodegroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AmiType": { - "type": "string" - }, - "CapacityType": { - "type": "string" - }, - "ClusterName": { - "type": "string" - }, - "DiskSize": { - "type": "number" - }, - "ForceUpdateEnabled": { - "type": "boolean" - }, - "InstanceTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Labels": { - "type": "object" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::EKS::Nodegroup.LaunchTemplateSpecification" - }, - "NodeRole": { - "type": "string" - }, - "NodegroupName": { - "type": "string" - }, - "ReleaseVersion": { - "type": "string" - }, - "RemoteAccess": { - "$ref": "#/definitions/AWS::EKS::Nodegroup.RemoteAccess" - }, - "ScalingConfig": { - "$ref": "#/definitions/AWS::EKS::Nodegroup.ScalingConfig" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "type": "object" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "ClusterName", - "NodeRole", - "Subnets" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EKS::Nodegroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EKS::Nodegroup.LaunchTemplateSpecification": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EKS::Nodegroup.RemoteAccess": { - "additionalProperties": false, - "properties": { - "Ec2SshKey": { - "type": "string" - }, - "SourceSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Ec2SshKey" - ], - "type": "object" - }, - "AWS::EKS::Nodegroup.ScalingConfig": { - "additionalProperties": false, - "properties": { - "DesiredSize": { - "type": "number" - }, - "MaxSize": { - "type": "number" - }, - "MinSize": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdditionalInfo": { - "type": "object" - }, - "Applications": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.Application" - }, - "type": "array" - }, - "AutoScalingRole": { - "type": "string" - }, - "BootstrapActions": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.BootstrapActionConfig" - }, - "type": "array" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.Configuration" - }, - "type": "array" - }, - "CustomAmiId": { - "type": "string" - }, - "EbsRootVolumeSize": { - "type": "number" - }, - "Instances": { - "$ref": "#/definitions/AWS::EMR::Cluster.JobFlowInstancesConfig" - }, - "JobFlowRole": { - "type": "string" - }, - "KerberosAttributes": { - "$ref": "#/definitions/AWS::EMR::Cluster.KerberosAttributes" - }, - "LogEncryptionKmsKeyId": { - "type": "string" - }, - "LogUri": { - "type": "string" - }, - "ManagedScalingPolicy": { - "$ref": "#/definitions/AWS::EMR::Cluster.ManagedScalingPolicy" - }, - "Name": { - "type": "string" - }, - "ReleaseLabel": { - "type": "string" - }, - "ScaleDownBehavior": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "ServiceRole": { - "type": "string" - }, - "StepConcurrencyLevel": { - "type": "number" - }, - "Steps": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.StepConfig" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VisibleToAllUsers": { - "type": "boolean" - } - }, - "required": [ - "Instances", - "JobFlowRole", - "Name", - "ServiceRole" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::Cluster.Application": { - "additionalProperties": false, - "properties": { - "AdditionalInfo": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Args": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.AutoScalingPolicy": { - "additionalProperties": false, - "properties": { - "Constraints": { - "$ref": "#/definitions/AWS::EMR::Cluster.ScalingConstraints" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.ScalingRule" - }, - "type": "array" - } - }, - "required": [ - "Constraints", - "Rules" - ], - "type": "object" - }, - "AWS::EMR::Cluster.BootstrapActionConfig": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ScriptBootstrapAction": { - "$ref": "#/definitions/AWS::EMR::Cluster.ScriptBootstrapActionConfig" - } - }, - "required": [ - "Name", - "ScriptBootstrapAction" - ], - "type": "object" - }, - "AWS::EMR::Cluster.CloudWatchAlarmDefinition": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.MetricDimension" - }, - "type": "array" - }, - "EvaluationPeriods": { - "type": "number" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Period": { - "type": "number" - }, - "Statistic": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "MetricName", - "Period", - "Threshold" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ComputeLimits": { - "additionalProperties": false, - "properties": { - "MaximumCapacityUnits": { - "type": "number" - }, - "MaximumCoreCapacityUnits": { - "type": "number" - }, - "MaximumOnDemandCapacityUnits": { - "type": "number" - }, - "MinimumCapacityUnits": { - "type": "number" - }, - "UnitType": { - "type": "string" - } - }, - "required": [ - "MaximumCapacityUnits", - "MinimumCapacityUnits", - "UnitType" - ], - "type": "object" - }, - "AWS::EMR::Cluster.Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.Configuration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/AWS::EMR::Cluster.VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "number" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "AWS::EMR::Cluster.EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.EbsBlockDeviceConfig" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.HadoopJarStepConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Jar": { - "type": "string" - }, - "MainClass": { - "type": "string" - }, - "StepProperties": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.KeyValue" - }, - "type": "array" - } - }, - "required": [ - "Jar" - ], - "type": "object" - }, - "AWS::EMR::Cluster.InstanceFleetConfig": { - "additionalProperties": false, - "properties": { - "InstanceTypeConfigs": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceTypeConfig" - }, - "type": "array" - }, - "LaunchSpecifications": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications" - }, - "Name": { - "type": "string" - }, - "TargetOnDemandCapacity": { - "type": "number" - }, - "TargetSpotCapacity": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.InstanceFleetProvisioningSpecifications": { - "additionalProperties": false, - "properties": { - "OnDemandSpecification": { - "$ref": "#/definitions/AWS::EMR::Cluster.OnDemandProvisioningSpecification" - }, - "SpotSpecification": { - "$ref": "#/definitions/AWS::EMR::Cluster.SpotProvisioningSpecification" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.InstanceGroupConfig": { - "additionalProperties": false, - "properties": { - "AutoScalingPolicy": { - "$ref": "#/definitions/AWS::EMR::Cluster.AutoScalingPolicy" - }, - "BidPrice": { - "type": "string" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.Configuration" - }, - "type": "array" - }, - "EbsConfiguration": { - "$ref": "#/definitions/AWS::EMR::Cluster.EbsConfiguration" - }, - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "Market": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "InstanceCount", - "InstanceType" - ], - "type": "object" - }, - "AWS::EMR::Cluster.InstanceTypeConfig": { - "additionalProperties": false, - "properties": { - "BidPrice": { - "type": "string" - }, - "BidPriceAsPercentageOfOnDemandPrice": { - "type": "number" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::Cluster.Configuration" - }, - "type": "array" - }, - "EbsConfiguration": { - "$ref": "#/definitions/AWS::EMR::Cluster.EbsConfiguration" - }, - "InstanceType": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "AWS::EMR::Cluster.JobFlowInstancesConfig": { - "additionalProperties": false, - "properties": { - "AdditionalMasterSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdditionalSlaveSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CoreInstanceFleet": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceFleetConfig" - }, - "CoreInstanceGroup": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceGroupConfig" - }, - "Ec2KeyName": { - "type": "string" - }, - "Ec2SubnetId": { - "type": "string" - }, - "Ec2SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EmrManagedMasterSecurityGroup": { - "type": "string" - }, - "EmrManagedSlaveSecurityGroup": { - "type": "string" - }, - "HadoopVersion": { - "type": "string" - }, - "KeepJobFlowAliveWhenNoSteps": { - "type": "boolean" - }, - "MasterInstanceFleet": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceFleetConfig" - }, - "MasterInstanceGroup": { - "$ref": "#/definitions/AWS::EMR::Cluster.InstanceGroupConfig" - }, - "Placement": { - "$ref": "#/definitions/AWS::EMR::Cluster.PlacementType" - }, - "ServiceAccessSecurityGroup": { - "type": "string" - }, - "TerminationProtected": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.KerberosAttributes": { - "additionalProperties": false, - "properties": { - "ADDomainJoinPassword": { - "type": "string" - }, - "ADDomainJoinUser": { - "type": "string" - }, - "CrossRealmTrustPrincipalPassword": { - "type": "string" - }, - "KdcAdminPassword": { - "type": "string" - }, - "Realm": { - "type": "string" - } - }, - "required": [ - "KdcAdminPassword", - "Realm" - ], - "type": "object" - }, - "AWS::EMR::Cluster.KeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.ManagedScalingPolicy": { - "additionalProperties": false, - "properties": { - "ComputeLimits": { - "$ref": "#/definitions/AWS::EMR::Cluster.ComputeLimits" - } - }, - "type": "object" - }, - "AWS::EMR::Cluster.MetricDimension": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EMR::Cluster.OnDemandProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - } - }, - "required": [ - "AllocationStrategy" - ], - "type": "object" - }, - "AWS::EMR::Cluster.PlacementType": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ScalingAction": { - "additionalProperties": false, - "properties": { - "Market": { - "type": "string" - }, - "SimpleScalingPolicyConfiguration": { - "$ref": "#/definitions/AWS::EMR::Cluster.SimpleScalingPolicyConfiguration" - } - }, - "required": [ - "SimpleScalingPolicyConfiguration" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ScalingConstraints": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - } - }, - "required": [ - "MaxCapacity", - "MinCapacity" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ScalingRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::EMR::Cluster.ScalingAction" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Trigger": { - "$ref": "#/definitions/AWS::EMR::Cluster.ScalingTrigger" - } - }, - "required": [ - "Action", - "Name", - "Trigger" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ScalingTrigger": { - "additionalProperties": false, - "properties": { - "CloudWatchAlarmDefinition": { - "$ref": "#/definitions/AWS::EMR::Cluster.CloudWatchAlarmDefinition" - } - }, - "required": [ - "CloudWatchAlarmDefinition" - ], - "type": "object" - }, - "AWS::EMR::Cluster.ScriptBootstrapActionConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Path": { - "type": "string" - } - }, - "required": [ - "Path" - ], - "type": "object" - }, - "AWS::EMR::Cluster.SimpleScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "CoolDown": { - "type": "number" - }, - "ScalingAdjustment": { - "type": "number" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "AWS::EMR::Cluster.SpotProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BlockDurationMinutes": { - "type": "number" - }, - "TimeoutAction": { - "type": "string" - }, - "TimeoutDurationMinutes": { - "type": "number" - } - }, - "required": [ - "TimeoutAction", - "TimeoutDurationMinutes" - ], - "type": "object" - }, - "AWS::EMR::Cluster.StepConfig": { - "additionalProperties": false, - "properties": { - "ActionOnFailure": { - "type": "string" - }, - "HadoopJarStep": { - "$ref": "#/definitions/AWS::EMR::Cluster.HadoopJarStepConfig" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "HadoopJarStep", - "Name" - ], - "type": "object" - }, - "AWS::EMR::Cluster.VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "number" - }, - "SizeInGB": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClusterId": { - "type": "string" - }, - "InstanceFleetType": { - "type": "string" - }, - "InstanceTypeConfigs": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.InstanceTypeConfig" - }, - "type": "array" - }, - "LaunchSpecifications": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications" - }, - "Name": { - "type": "string" - }, - "TargetOnDemandCapacity": { - "type": "number" - }, - "TargetSpotCapacity": { - "type": "number" - } - }, - "required": [ - "ClusterId", - "InstanceFleetType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::InstanceFleetConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.Configuration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "number" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.EbsBlockDeviceConfig" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.InstanceFleetProvisioningSpecifications": { - "additionalProperties": false, - "properties": { - "OnDemandSpecification": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.OnDemandProvisioningSpecification" - }, - "SpotSpecification": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification" - } - }, - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.InstanceTypeConfig": { - "additionalProperties": false, - "properties": { - "BidPrice": { - "type": "string" - }, - "BidPriceAsPercentageOfOnDemandPrice": { - "type": "number" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.Configuration" - }, - "type": "array" - }, - "EbsConfiguration": { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.EbsConfiguration" - }, - "InstanceType": { - "type": "string" - }, - "WeightedCapacity": { - "type": "number" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.OnDemandProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - } - }, - "required": [ - "AllocationStrategy" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification": { - "additionalProperties": false, - "properties": { - "AllocationStrategy": { - "type": "string" - }, - "BlockDurationMinutes": { - "type": "number" - }, - "TimeoutAction": { - "type": "string" - }, - "TimeoutDurationMinutes": { - "type": "number" - } - }, - "required": [ - "TimeoutAction", - "TimeoutDurationMinutes" - ], - "type": "object" - }, - "AWS::EMR::InstanceFleetConfig.VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "number" - }, - "SizeInGB": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingPolicy": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.AutoScalingPolicy" - }, - "BidPrice": { - "type": "string" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.Configuration" - }, - "type": "array" - }, - "EbsConfiguration": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.EbsConfiguration" - }, - "InstanceCount": { - "type": "number" - }, - "InstanceRole": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "JobFlowId": { - "type": "string" - }, - "Market": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "InstanceCount", - "InstanceRole", - "InstanceType", - "JobFlowId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::InstanceGroupConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.AutoScalingPolicy": { - "additionalProperties": false, - "properties": { - "Constraints": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.ScalingConstraints" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.ScalingRule" - }, - "type": "array" - } - }, - "required": [ - "Constraints", - "Rules" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.MetricDimension" - }, - "type": "array" - }, - "EvaluationPeriods": { - "type": "number" - }, - "MetricName": { - "type": "string" - }, - "Namespace": { - "type": "string" - }, - "Period": { - "type": "number" - }, - "Statistic": { - "type": "string" - }, - "Threshold": { - "type": "number" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "MetricName", - "Period", - "Threshold" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.Configuration": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "ConfigurationProperties": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Configurations": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.Configuration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig": { - "additionalProperties": false, - "properties": { - "VolumeSpecification": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.VolumeSpecification" - }, - "VolumesPerInstance": { - "type": "number" - } - }, - "required": [ - "VolumeSpecification" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.EbsConfiguration": { - "additionalProperties": false, - "properties": { - "EbsBlockDeviceConfigs": { - "items": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.EbsBlockDeviceConfig" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.MetricDimension": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.ScalingAction": { - "additionalProperties": false, - "properties": { - "Market": { - "type": "string" - }, - "SimpleScalingPolicyConfiguration": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration" - } - }, - "required": [ - "SimpleScalingPolicyConfiguration" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.ScalingConstraints": { - "additionalProperties": false, - "properties": { - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - } - }, - "required": [ - "MaxCapacity", - "MinCapacity" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.ScalingRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.ScalingAction" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Trigger": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.ScalingTrigger" - } - }, - "required": [ - "Action", - "Name", - "Trigger" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.ScalingTrigger": { - "additionalProperties": false, - "properties": { - "CloudWatchAlarmDefinition": { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.CloudWatchAlarmDefinition" - } - }, - "required": [ - "CloudWatchAlarmDefinition" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.SimpleScalingPolicyConfiguration": { - "additionalProperties": false, - "properties": { - "AdjustmentType": { - "type": "string" - }, - "CoolDown": { - "type": "number" - }, - "ScalingAdjustment": { - "type": "number" - } - }, - "required": [ - "ScalingAdjustment" - ], - "type": "object" - }, - "AWS::EMR::InstanceGroupConfig.VolumeSpecification": { - "additionalProperties": false, - "properties": { - "Iops": { - "type": "number" - }, - "SizeInGB": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "required": [ - "SizeInGB", - "VolumeType" - ], - "type": "object" - }, - "AWS::EMR::SecurityConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "object" - } - }, - "required": [ - "SecurityConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::SecurityConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::Step": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ActionOnFailure": { - "type": "string" - }, - "HadoopJarStep": { - "$ref": "#/definitions/AWS::EMR::Step.HadoopJarStepConfig" - }, - "JobFlowId": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ActionOnFailure", - "HadoopJarStep", - "JobFlowId", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::Step" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::Step.HadoopJarStepConfig": { - "additionalProperties": false, - "properties": { - "Args": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Jar": { - "type": "string" - }, - "MainClass": { - "type": "string" - }, - "StepProperties": { - "items": { - "$ref": "#/definitions/AWS::EMR::Step.KeyValue" - }, - "type": "array" - } - }, - "required": [ - "Jar" - ], - "type": "object" - }, - "AWS::EMR::Step.KeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::EMR::Studio": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthMode": { - "type": "string" - }, - "DefaultS3Location": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EngineSecurityGroupId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ServiceRole": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserRole": { - "type": "string" - }, - "VpcId": { - "type": "string" - }, - "WorkspaceSecurityGroupId": { - "type": "string" - } - }, - "required": [ - "AuthMode", - "DefaultS3Location", - "EngineSecurityGroupId", - "Name", - "ServiceRole", - "SubnetIds", - "UserRole", - "VpcId", - "WorkspaceSecurityGroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::Studio" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMR::StudioSessionMapping": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "IdentityName": { - "type": "string" - }, - "IdentityType": { - "type": "string" - }, - "SessionPolicyArn": { - "type": "string" - }, - "StudioId": { - "type": "string" - } - }, - "required": [ - "IdentityName", - "IdentityType", - "SessionPolicyArn", - "StudioId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMR::StudioSessionMapping" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMRContainers::VirtualCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContainerProvider": { - "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster.ContainerProvider" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ContainerProvider", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EMRContainers::VirtualCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EMRContainers::VirtualCluster.ContainerInfo": { - "additionalProperties": false, - "properties": { - "EksInfo": { - "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster.EksInfo" - } - }, - "required": [ - "EksInfo" - ], - "type": "object" - }, - "AWS::EMRContainers::VirtualCluster.ContainerProvider": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Info": { - "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster.ContainerInfo" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Id", - "Info", - "Type" - ], - "type": "object" - }, - "AWS::EMRContainers::VirtualCluster.EksInfo": { - "additionalProperties": false, - "properties": { - "Namespace": { - "type": "string" - } - }, - "required": [ - "Namespace" - ], - "type": "object" - }, - "AWS::ElastiCache::CacheCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AZMode": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "CacheNodeType": { - "type": "string" - }, - "CacheParameterGroupName": { - "type": "string" - }, - "CacheSecurityGroupNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CacheSubnetGroupName": { - "type": "string" - }, - "ClusterName": { - "type": "string" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "NotificationTopicArn": { - "type": "string" - }, - "NumCacheNodes": { - "type": "number" - }, - "Port": { - "type": "number" - }, - "PreferredAvailabilityZone": { - "type": "string" - }, - "PreferredAvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "SnapshotArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnapshotName": { - "type": "string" - }, - "SnapshotRetentionLimit": { - "type": "number" - }, - "SnapshotWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "CacheNodeType", - "Engine", - "NumCacheNodes" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::CacheCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::GlobalReplicationGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutomaticFailoverEnabled": { - "type": "boolean" - }, - "CacheNodeType": { - "type": "string" - }, - "CacheParameterGroupName": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "GlobalNodeGroupCount": { - "type": "number" - }, - "GlobalReplicationGroupDescription": { - "type": "string" - }, - "GlobalReplicationGroupIdSuffix": { - "type": "string" - }, - "Members": { - "items": { - "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup.GlobalReplicationGroupMember" - }, - "type": "array" - }, - "RegionalConfigurations": { - "items": { - "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration" - }, - "type": "array" - } - }, - "required": [ - "Members" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::GlobalReplicationGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::GlobalReplicationGroup.GlobalReplicationGroupMember": { - "additionalProperties": false, - "properties": { - "ReplicationGroupId": { - "type": "string" - }, - "ReplicationGroupRegion": { - "type": "string" - }, - "Role": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration": { - "additionalProperties": false, - "properties": { - "ReplicationGroupId": { - "type": "string" - }, - "ReplicationGroupRegion": { - "type": "string" - }, - "ReshardingConfigurations": { - "items": { - "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup.ReshardingConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElastiCache::GlobalReplicationGroup.ReshardingConfiguration": { - "additionalProperties": false, - "properties": { - "NodeGroupId": { - "type": "string" - }, - "PreferredAvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElastiCache::ParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CacheParameterGroupFamily": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Properties": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "CacheParameterGroupFamily", - "Description" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::ParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::ReplicationGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AtRestEncryptionEnabled": { - "type": "boolean" - }, - "AuthToken": { - "type": "string" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AutomaticFailoverEnabled": { - "type": "boolean" - }, - "CacheNodeType": { - "type": "string" - }, - "CacheParameterGroupName": { - "type": "string" - }, - "CacheSecurityGroupNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CacheSubnetGroupName": { - "type": "string" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "GlobalReplicationGroupId": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MultiAZEnabled": { - "type": "boolean" - }, - "NodeGroupConfiguration": { - "items": { - "$ref": "#/definitions/AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration" - }, - "type": "array" - }, - "NotificationTopicArn": { - "type": "string" - }, - "NumCacheClusters": { - "type": "number" - }, - "NumNodeGroups": { - "type": "number" - }, - "Port": { - "type": "number" - }, - "PreferredCacheClusterAZs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "PrimaryClusterId": { - "type": "string" - }, - "ReplicasPerNodeGroup": { - "type": "number" - }, - "ReplicationGroupDescription": { - "type": "string" - }, - "ReplicationGroupId": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnapshotArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnapshotName": { - "type": "string" - }, - "SnapshotRetentionLimit": { - "type": "number" - }, - "SnapshotWindow": { - "type": "string" - }, - "SnapshottingClusterId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TransitEncryptionEnabled": { - "type": "boolean" - }, - "UserGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ReplicationGroupDescription" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::ReplicationGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::ReplicationGroup.NodeGroupConfiguration": { - "additionalProperties": false, - "properties": { - "NodeGroupId": { - "type": "string" - }, - "PrimaryAvailabilityZone": { - "type": "string" - }, - "ReplicaAvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ReplicaCount": { - "type": "number" - }, - "Slots": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElastiCache::SecurityGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - } - }, - "required": [ - "Description" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::SecurityGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::SecurityGroupIngress": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CacheSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - } - }, - "required": [ - "CacheSecurityGroupName", - "EC2SecurityGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::SecurityGroupIngress" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::SubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CacheSubnetGroupName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Description", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::SubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::User": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessString": { - "type": "string" - }, - "Engine": { - "type": "string" - }, - "NoPasswordRequired": { - "type": "boolean" - }, - "Passwords": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UserId": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "required": [ - "Engine", - "UserId", - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::User" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElastiCache::UserGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Engine": { - "type": "string" - }, - "UserGroupId": { - "type": "string" - }, - "UserIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Engine", - "UserGroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElastiCache::UserGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ResourceLifecycleConfig": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticBeanstalk::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::Application.ApplicationResourceLifecycleConfig": { - "additionalProperties": false, - "properties": { - "ServiceRole": { - "type": "string" - }, - "VersionLifecycleConfig": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig" - } - }, - "type": "object" - }, - "AWS::ElasticBeanstalk::Application.ApplicationVersionLifecycleConfig": { - "additionalProperties": false, - "properties": { - "MaxAgeRule": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Application.MaxAgeRule" - }, - "MaxCountRule": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Application.MaxCountRule" - } - }, - "type": "object" - }, - "AWS::ElasticBeanstalk::Application.MaxAgeRule": { - "additionalProperties": false, - "properties": { - "DeleteSourceFromS3": { - "type": "boolean" - }, - "Enabled": { - "type": "boolean" - }, - "MaxAgeInDays": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ElasticBeanstalk::Application.MaxCountRule": { - "additionalProperties": false, - "properties": { - "DeleteSourceFromS3": { - "type": "boolean" - }, - "Enabled": { - "type": "boolean" - }, - "MaxCount": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ElasticBeanstalk::ApplicationVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "SourceBundle": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle" - } - }, - "required": [ - "ApplicationName", - "SourceBundle" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticBeanstalk::ApplicationVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::ConfigurationTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EnvironmentId": { - "type": "string" - }, - "OptionSettings": { - "items": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting" - }, - "type": "array" - }, - "PlatformArn": { - "type": "string" - }, - "SolutionStackName": { - "type": "string" - }, - "SourceConfiguration": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration" - } - }, - "required": [ - "ApplicationName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticBeanstalk::ConfigurationTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::ConfigurationTemplate.ConfigurationOptionSetting": { - "additionalProperties": false, - "properties": { - "Namespace": { - "type": "string" - }, - "OptionName": { - "type": "string" - }, - "ResourceName": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Namespace", - "OptionName" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::ConfigurationTemplate.SourceConfiguration": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "required": [ - "ApplicationName", - "TemplateName" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::Environment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "CNAMEPrefix": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EnvironmentName": { - "type": "string" - }, - "OptionSettings": { - "items": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Environment.OptionSetting" - }, - "type": "array" - }, - "PlatformArn": { - "type": "string" - }, - "SolutionStackName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TemplateName": { - "type": "string" - }, - "Tier": { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Environment.Tier" - }, - "VersionLabel": { - "type": "string" - } - }, - "required": [ - "ApplicationName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticBeanstalk::Environment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::Environment.OptionSetting": { - "additionalProperties": false, - "properties": { - "Namespace": { - "type": "string" - }, - "OptionName": { - "type": "string" - }, - "ResourceName": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Namespace", - "OptionName" - ], - "type": "object" - }, - "AWS::ElasticBeanstalk::Environment.Tier": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessLoggingPolicy": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy" - }, - "AppCookieStickinessPolicy": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy" - }, - "type": "array" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ConnectionDrainingPolicy": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy" - }, - "ConnectionSettings": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings" - }, - "CrossZone": { - "type": "boolean" - }, - "HealthCheck": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck" - }, - "Instances": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LBCookieStickinessPolicy": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy" - }, - "type": "array" - }, - "Listeners": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.Listeners" - }, - "type": "array" - }, - "LoadBalancerName": { - "type": "string" - }, - "Policies": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer.Policies" - }, - "type": "array" - }, - "Scheme": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Listeners" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancing::LoadBalancer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.AccessLoggingPolicy": { - "additionalProperties": false, - "properties": { - "EmitInterval": { - "type": "number" - }, - "Enabled": { - "type": "boolean" - }, - "S3BucketName": { - "type": "string" - }, - "S3BucketPrefix": { - "type": "string" - } - }, - "required": [ - "Enabled", - "S3BucketName" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.AppCookieStickinessPolicy": { - "additionalProperties": false, - "properties": { - "CookieName": { - "type": "string" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "CookieName", - "PolicyName" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.ConnectionDrainingPolicy": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Timeout": { - "type": "number" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.ConnectionSettings": { - "additionalProperties": false, - "properties": { - "IdleTimeout": { - "type": "number" - } - }, - "required": [ - "IdleTimeout" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.HealthCheck": { - "additionalProperties": false, - "properties": { - "HealthyThreshold": { - "type": "string" - }, - "Interval": { - "type": "string" - }, - "Target": { - "type": "string" - }, - "Timeout": { - "type": "string" - }, - "UnhealthyThreshold": { - "type": "string" - } - }, - "required": [ - "HealthyThreshold", - "Interval", - "Target", - "Timeout", - "UnhealthyThreshold" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.LBCookieStickinessPolicy": { - "additionalProperties": false, - "properties": { - "CookieExpirationPeriod": { - "type": "string" - }, - "PolicyName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.Listeners": { - "additionalProperties": false, - "properties": { - "InstancePort": { - "type": "string" - }, - "InstanceProtocol": { - "type": "string" - }, - "LoadBalancerPort": { - "type": "string" - }, - "PolicyNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Protocol": { - "type": "string" - }, - "SSLCertificateId": { - "type": "string" - } - }, - "required": [ - "InstancePort", - "LoadBalancerPort", - "Protocol" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancing::LoadBalancer.Policies": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "type": "object" - }, - "type": "array" - }, - "InstancePorts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LoadBalancerPorts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PolicyName": { - "type": "string" - }, - "PolicyType": { - "type": "string" - } - }, - "required": [ - "Attributes", - "PolicyName", - "PolicyType" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AlpnPolicy": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Certificates": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.Certificate" - }, - "type": "array" - }, - "DefaultActions": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.Action" - }, - "type": "array" - }, - "LoadBalancerArn": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "SslPolicy": { - "type": "string" - } - }, - "required": [ - "DefaultActions", - "LoadBalancerArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancingV2::Listener" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.Action": { - "additionalProperties": false, - "properties": { - "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig" - }, - "AuthenticateOidcConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig" - }, - "FixedResponseConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig" - }, - "ForwardConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.ForwardConfig" - }, - "Order": { - "type": "number" - }, - "RedirectConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.RedirectConfig" - }, - "TargetGroupArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig": { - "additionalProperties": false, - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "OnUnauthenticatedRequest": { - "type": "string" - }, - "Scope": { - "type": "string" - }, - "SessionCookieName": { - "type": "string" - }, - "SessionTimeout": { - "type": "string" - }, - "UserPoolArn": { - "type": "string" - }, - "UserPoolClientId": { - "type": "string" - }, - "UserPoolDomain": { - "type": "string" - } - }, - "required": [ - "UserPoolArn", - "UserPoolClientId", - "UserPoolDomain" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.AuthenticateOidcConfig": { - "additionalProperties": false, - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "AuthorizationEndpoint": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "Issuer": { - "type": "string" - }, - "OnUnauthenticatedRequest": { - "type": "string" - }, - "Scope": { - "type": "string" - }, - "SessionCookieName": { - "type": "string" - }, - "SessionTimeout": { - "type": "string" - }, - "TokenEndpoint": { - "type": "string" - }, - "UserInfoEndpoint": { - "type": "string" - } - }, - "required": [ - "AuthorizationEndpoint", - "ClientId", - "ClientSecret", - "Issuer", - "TokenEndpoint", - "UserInfoEndpoint" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.Certificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.FixedResponseConfig": { - "additionalProperties": false, - "properties": { - "ContentType": { - "type": "string" - }, - "MessageBody": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.ForwardConfig": { - "additionalProperties": false, - "properties": { - "TargetGroupStickinessConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig" - }, - "TargetGroups": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.RedirectConfig": { - "additionalProperties": false, - "properties": { - "Host": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "Query": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.TargetGroupStickinessConfig": { - "additionalProperties": false, - "properties": { - "DurationSeconds": { - "type": "number" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::Listener.TargetGroupTuple": { - "additionalProperties": false, - "properties": { - "TargetGroupArn": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerCertificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Certificates": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate" - }, - "type": "array" - }, - "ListenerArn": { - "type": "string" - } - }, - "required": [ - "Certificates", - "ListenerArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancingV2::ListenerCertificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.Action" - }, - "type": "array" - }, - "Conditions": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition" - }, - "type": "array" - }, - "ListenerArn": { - "type": "string" - }, - "Priority": { - "type": "number" - } - }, - "required": [ - "Actions", - "Conditions", - "ListenerArn", - "Priority" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancingV2::ListenerRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.Action": { - "additionalProperties": false, - "properties": { - "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig" - }, - "AuthenticateOidcConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig" - }, - "FixedResponseConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig" - }, - "ForwardConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig" - }, - "Order": { - "type": "number" - }, - "RedirectConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig" - }, - "TargetGroupArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateCognitoConfig": { - "additionalProperties": false, - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "OnUnauthenticatedRequest": { - "type": "string" - }, - "Scope": { - "type": "string" - }, - "SessionCookieName": { - "type": "string" - }, - "SessionTimeout": { - "type": "number" - }, - "UserPoolArn": { - "type": "string" - }, - "UserPoolClientId": { - "type": "string" - }, - "UserPoolDomain": { - "type": "string" - } - }, - "required": [ - "UserPoolArn", - "UserPoolClientId", - "UserPoolDomain" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.AuthenticateOidcConfig": { - "additionalProperties": false, - "properties": { - "AuthenticationRequestExtraParams": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "AuthorizationEndpoint": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "Issuer": { - "type": "string" - }, - "OnUnauthenticatedRequest": { - "type": "string" - }, - "Scope": { - "type": "string" - }, - "SessionCookieName": { - "type": "string" - }, - "SessionTimeout": { - "type": "number" - }, - "TokenEndpoint": { - "type": "string" - }, - "UseExistingClientSecret": { - "type": "boolean" - }, - "UserInfoEndpoint": { - "type": "string" - } - }, - "required": [ - "AuthorizationEndpoint", - "ClientId", - "ClientSecret", - "Issuer", - "TokenEndpoint", - "UserInfoEndpoint" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.FixedResponseConfig": { - "additionalProperties": false, - "properties": { - "ContentType": { - "type": "string" - }, - "MessageBody": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.ForwardConfig": { - "additionalProperties": false, - "properties": { - "TargetGroupStickinessConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig" - }, - "TargetGroups": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig": { - "additionalProperties": false, - "properties": { - "HttpHeaderName": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.RedirectConfig": { - "additionalProperties": false, - "properties": { - "Host": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "Port": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "Query": { - "type": "string" - }, - "StatusCode": { - "type": "string" - } - }, - "required": [ - "StatusCode" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.RuleCondition": { - "additionalProperties": false, - "properties": { - "Field": { - "type": "string" - }, - "HostHeaderConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.HostHeaderConfig" - }, - "HttpHeaderConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.HttpHeaderConfig" - }, - "HttpRequestMethodConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.HttpRequestMethodConfig" - }, - "PathPatternConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.PathPatternConfig" - }, - "QueryStringConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringConfig" - }, - "SourceIpConfig": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.SourceIpConfig": { - "additionalProperties": false, - "properties": { - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupStickinessConfig": { - "additionalProperties": false, - "properties": { - "DurationSeconds": { - "type": "number" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::ListenerRule.TargetGroupTuple": { - "additionalProperties": false, - "properties": { - "TargetGroupArn": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::LoadBalancer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "IpAddressType": { - "type": "string" - }, - "LoadBalancerAttributes": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Scheme": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetMappings": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancingV2::LoadBalancer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMapping": { - "additionalProperties": false, - "properties": { - "AllocationId": { - "type": "string" - }, - "IPv6Address": { - "type": "string" - }, - "PrivateIPv4Address": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::TargetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HealthCheckEnabled": { - "type": "boolean" - }, - "HealthCheckIntervalSeconds": { - "type": "number" - }, - "HealthCheckPath": { - "type": "string" - }, - "HealthCheckPort": { - "type": "string" - }, - "HealthCheckProtocol": { - "type": "string" - }, - "HealthCheckTimeoutSeconds": { - "type": "number" - }, - "HealthyThresholdCount": { - "type": "number" - }, - "Matcher": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup.Matcher" - }, - "Name": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "ProtocolVersion": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetGroupAttributes": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute" - }, - "type": "array" - }, - "TargetType": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription" - }, - "type": "array" - }, - "UnhealthyThresholdCount": { - "type": "number" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ElasticLoadBalancingV2::TargetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::TargetGroup.Matcher": { - "additionalProperties": false, - "properties": { - "GrpcCode": { - "type": "string" - }, - "HttpCode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::TargetGroup.TargetDescription": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Port": { - "type": "number" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessPolicies": { - "type": "object" - }, - "AdvancedOptions": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "AdvancedSecurityOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput" - }, - "CognitoOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.CognitoOptions" - }, - "DomainEndpointOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.DomainEndpointOptions" - }, - "DomainName": { - "type": "string" - }, - "EBSOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.EBSOptions" - }, - "ElasticsearchClusterConfig": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.ElasticsearchClusterConfig" - }, - "ElasticsearchVersion": { - "type": "string" - }, - "EncryptionAtRestOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.EncryptionAtRestOptions" - }, - "LogPublishingOptions": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.LogPublishingOption" - } - }, - "type": "object" - }, - "NodeToNodeEncryptionOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions" - }, - "SnapshotOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.SnapshotOptions" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VPCOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.VPCOptions" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Elasticsearch::Domain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "InternalUserDatabaseEnabled": { - "type": "boolean" - }, - "MasterUserOptions": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.MasterUserOptions" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.CognitoOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "IdentityPoolId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UserPoolId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.DomainEndpointOptions": { - "additionalProperties": false, - "properties": { - "CustomEndpoint": { - "type": "string" - }, - "CustomEndpointCertificateArn": { - "type": "string" - }, - "CustomEndpointEnabled": { - "type": "boolean" - }, - "EnforceHTTPS": { - "type": "boolean" - }, - "TLSSecurityPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.EBSOptions": { - "additionalProperties": false, - "properties": { - "EBSEnabled": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.ElasticsearchClusterConfig": { - "additionalProperties": false, - "properties": { - "DedicatedMasterCount": { - "type": "number" - }, - "DedicatedMasterEnabled": { - "type": "boolean" - }, - "DedicatedMasterType": { - "type": "string" - }, - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "WarmCount": { - "type": "number" - }, - "WarmEnabled": { - "type": "boolean" - }, - "WarmType": { - "type": "string" - }, - "ZoneAwarenessConfig": { - "$ref": "#/definitions/AWS::Elasticsearch::Domain.ZoneAwarenessConfig" - }, - "ZoneAwarenessEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.EncryptionAtRestOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "KmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.LogPublishingOption": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.MasterUserOptions": { - "additionalProperties": false, - "properties": { - "MasterUserARN": { - "type": "string" - }, - "MasterUserName": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.SnapshotOptions": { - "additionalProperties": false, - "properties": { - "AutomatedSnapshotStartHour": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.VPCOptions": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Elasticsearch::Domain.ZoneAwarenessConfig": { - "additionalProperties": false, - "properties": { - "AvailabilityZoneCount": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::EventSchemas::Discoverer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "SourceArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::EventSchemas::Discoverer.TagsEntry" - }, - "type": "array" - } - }, - "required": [ - "SourceArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EventSchemas::Discoverer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EventSchemas::Discoverer.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EventSchemas::Registry": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "RegistryName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::EventSchemas::Registry.TagsEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EventSchemas::Registry" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::EventSchemas::Registry.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::EventSchemas::RegistryPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Policy": { - "type": "object" - }, - "RegistryName": { - "type": "string" - }, - "RevisionId": { - "type": "string" - } - }, - "required": [ - "Policy", - "RegistryName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EventSchemas::RegistryPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EventSchemas::Schema": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Content": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "RegistryName": { - "type": "string" - }, - "SchemaName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::EventSchemas::Schema.TagsEntry" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Content", - "RegistryName", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::EventSchemas::Schema" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::EventSchemas::Schema.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::Events::ApiDestination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "HttpMethod": { - "type": "string" - }, - "InvocationEndpoint": { - "type": "string" - }, - "InvocationRateLimitPerSecond": { - "type": "number" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ConnectionArn", - "HttpMethod", - "InvocationEndpoint" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::ApiDestination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Events::Archive": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ArchiveName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "EventPattern": { - "type": "object" - }, - "RetentionDays": { - "type": "number" - }, - "SourceArn": { - "type": "string" - } - }, - "required": [ - "SourceArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::Archive" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Events::Connection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthParameters": { - "type": "object" - }, - "AuthorizationType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "AuthParameters", - "AuthorizationType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::Connection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Events::EventBus": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EventSourceName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::EventBus" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Events::EventBusPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Condition": { - "$ref": "#/definitions/AWS::Events::EventBusPolicy.Condition" - }, - "EventBusName": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "Statement": { - "type": "object" - }, - "StatementId": { - "type": "string" - } - }, - "required": [ - "StatementId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::EventBusPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Events::EventBusPolicy.Condition": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Events::Rule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "EventBusName": { - "type": "string" - }, - "EventPattern": { - "type": "object" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "ScheduleExpression": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::Events::Rule.Target" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Events::Rule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Events::Rule.AwsVpcConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Subnets" - ], - "type": "object" - }, - "AWS::Events::Rule.BatchArrayProperties": { - "additionalProperties": false, - "properties": { - "Size": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Events::Rule.BatchParameters": { - "additionalProperties": false, - "properties": { - "ArrayProperties": { - "$ref": "#/definitions/AWS::Events::Rule.BatchArrayProperties" - }, - "JobDefinition": { - "type": "string" - }, - "JobName": { - "type": "string" - }, - "RetryStrategy": { - "$ref": "#/definitions/AWS::Events::Rule.BatchRetryStrategy" - } - }, - "required": [ - "JobDefinition", - "JobName" - ], - "type": "object" - }, - "AWS::Events::Rule.BatchRetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Events::Rule.DeadLetterConfig": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Events::Rule.EcsParameters": { - "additionalProperties": false, - "properties": { - "Group": { - "type": "string" - }, - "LaunchType": { - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::Events::Rule.NetworkConfiguration" - }, - "PlatformVersion": { - "type": "string" - }, - "TaskCount": { - "type": "number" - }, - "TaskDefinitionArn": { - "type": "string" - } - }, - "required": [ - "TaskDefinitionArn" - ], - "type": "object" - }, - "AWS::Events::Rule.HttpParameters": { - "additionalProperties": false, - "properties": { - "HeaderParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "PathParameterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "QueryStringParameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::Events::Rule.InputTransformer": { - "additionalProperties": false, - "properties": { - "InputPathsMap": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "InputTemplate": { - "type": "string" - } - }, - "required": [ - "InputTemplate" - ], - "type": "object" - }, - "AWS::Events::Rule.KinesisParameters": { - "additionalProperties": false, - "properties": { - "PartitionKeyPath": { - "type": "string" - } - }, - "required": [ - "PartitionKeyPath" - ], - "type": "object" - }, - "AWS::Events::Rule.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AwsVpcConfiguration": { - "$ref": "#/definitions/AWS::Events::Rule.AwsVpcConfiguration" - } - }, - "type": "object" - }, - "AWS::Events::Rule.RedshiftDataParameters": { - "additionalProperties": false, - "properties": { - "Database": { - "type": "string" - }, - "DbUser": { - "type": "string" - }, - "SecretManagerArn": { - "type": "string" - }, - "Sql": { - "type": "string" - }, - "StatementName": { - "type": "string" - }, - "WithEvent": { - "type": "boolean" - } - }, - "required": [ - "Database", - "Sql" - ], - "type": "object" - }, - "AWS::Events::Rule.RetryPolicy": { - "additionalProperties": false, - "properties": { - "MaximumEventAgeInSeconds": { - "type": "number" - }, - "MaximumRetryAttempts": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Events::Rule.RunCommandParameters": { - "additionalProperties": false, - "properties": { - "RunCommandTargets": { - "items": { - "$ref": "#/definitions/AWS::Events::Rule.RunCommandTarget" - }, - "type": "array" - } - }, - "required": [ - "RunCommandTargets" - ], - "type": "object" - }, - "AWS::Events::Rule.RunCommandTarget": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key", - "Values" - ], - "type": "object" - }, - "AWS::Events::Rule.SqsParameters": { - "additionalProperties": false, - "properties": { - "MessageGroupId": { - "type": "string" - } - }, - "required": [ - "MessageGroupId" - ], - "type": "object" - }, - "AWS::Events::Rule.Target": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "BatchParameters": { - "$ref": "#/definitions/AWS::Events::Rule.BatchParameters" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Events::Rule.DeadLetterConfig" - }, - "EcsParameters": { - "$ref": "#/definitions/AWS::Events::Rule.EcsParameters" - }, - "HttpParameters": { - "$ref": "#/definitions/AWS::Events::Rule.HttpParameters" - }, - "Id": { - "type": "string" - }, - "Input": { - "type": "string" - }, - "InputPath": { - "type": "string" - }, - "InputTransformer": { - "$ref": "#/definitions/AWS::Events::Rule.InputTransformer" - }, - "KinesisParameters": { - "$ref": "#/definitions/AWS::Events::Rule.KinesisParameters" - }, - "RedshiftDataParameters": { - "$ref": "#/definitions/AWS::Events::Rule.RedshiftDataParameters" - }, - "RetryPolicy": { - "$ref": "#/definitions/AWS::Events::Rule.RetryPolicy" - }, - "RoleArn": { - "type": "string" - }, - "RunCommandParameters": { - "$ref": "#/definitions/AWS::Events::Rule.RunCommandParameters" - }, - "SqsParameters": { - "$ref": "#/definitions/AWS::Events::Rule.SqsParameters" - } - }, - "required": [ - "Arn", - "Id" - ], - "type": "object" - }, - "AWS::FIS::ExperimentTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "actions": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateAction" - } - }, - "type": "object" - }, - "description": { - "type": "string" - }, - "roleArn": { - "type": "string" - }, - "stopConditions": { - "items": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateStopCondition" - }, - "type": "array" - }, - "tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "targets": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateTarget" - } - }, - "type": "object" - } - }, - "required": [ - "description", - "roleArn", - "stopConditions", - "tags", - "targets" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::FIS::ExperimentTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateAction": { - "additionalProperties": false, - "properties": { - "actionId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "parameters": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemParameterMap" - }, - "startAfter": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemStartAfterList" - }, - "targets": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemTargetMap" - } - }, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemParameterMap": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemStartAfterList": { - "additionalProperties": false, - "properties": { - "ExperimentTemplateActionItemStartAfterList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateActionItemTargetMap": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateStopCondition": { - "additionalProperties": false, - "properties": { - "source": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "source" - ], - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateTarget": { - "additionalProperties": false, - "properties": { - "filters": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilterList" - }, - "resourceArns": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ResourceArnList" - }, - "resourceTags": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.TagMap" - }, - "resourceType": { - "type": "string" - }, - "selectionMode": { - "type": "string" - } - }, - "required": [ - "resourceType", - "selectionMode" - ], - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilter": { - "additionalProperties": false, - "properties": { - "path": { - "type": "string" - }, - "values": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilterValues" - } - }, - "required": [ - "path", - "values" - ], - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilterList": { - "additionalProperties": false, - "properties": { - "ExperimentTemplateTargetFilterList": { - "items": { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ExperimentTemplateTargetFilterValues": { - "additionalProperties": false, - "properties": { - "ExperimentTemplateTargetFilterValues": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.ResourceArnList": { - "additionalProperties": false, - "properties": { - "ResourceArnList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::FIS::ExperimentTemplate.TagMap": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::FMS::NotificationChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SnsRoleName": { - "type": "string" - }, - "SnsTopicArn": { - "type": "string" - } - }, - "required": [ - "SnsRoleName", - "SnsTopicArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::FMS::NotificationChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::FMS::Policy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeleteAllPolicyResources": { - "type": "boolean" - }, - "ExcludeMap": { - "$ref": "#/definitions/AWS::FMS::Policy.IEMap" - }, - "ExcludeResourceTags": { - "type": "boolean" - }, - "IncludeMap": { - "$ref": "#/definitions/AWS::FMS::Policy.IEMap" - }, - "PolicyName": { - "type": "string" - }, - "RemediationEnabled": { - "type": "boolean" - }, - "ResourceTags": { - "items": { - "$ref": "#/definitions/AWS::FMS::Policy.ResourceTag" - }, - "type": "array" - }, - "ResourceType": { - "type": "string" - }, - "ResourceTypeList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityServicePolicyData": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::FMS::Policy.PolicyTag" - }, - "type": "array" - } - }, - "required": [ - "ExcludeResourceTags", - "PolicyName", - "RemediationEnabled", - "ResourceType", - "SecurityServicePolicyData" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::FMS::Policy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::FMS::Policy.IEMap": { - "additionalProperties": false, - "properties": { - "ACCOUNT": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ORGUNIT": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::FMS::Policy.PolicyTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::FMS::Policy.ResourceTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key" - ], - "type": "object" - }, - "AWS::FSx::FileSystem": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BackupId": { - "type": "string" - }, - "FileSystemType": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "LustreConfiguration": { - "$ref": "#/definitions/AWS::FSx::FileSystem.LustreConfiguration" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StorageCapacity": { - "type": "number" - }, - "StorageType": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "WindowsConfiguration": { - "$ref": "#/definitions/AWS::FSx::FileSystem.WindowsConfiguration" - } - }, - "required": [ - "FileSystemType", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::FSx::FileSystem" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::FSx::FileSystem.LustreConfiguration": { - "additionalProperties": false, - "properties": { - "AutoImportPolicy": { - "type": "string" - }, - "AutomaticBackupRetentionDays": { - "type": "number" - }, - "CopyTagsToBackups": { - "type": "boolean" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "DriveCacheType": { - "type": "string" - }, - "ExportPath": { - "type": "string" - }, - "ImportPath": { - "type": "string" - }, - "ImportedFileChunkSize": { - "type": "number" - }, - "PerUnitStorageThroughput": { - "type": "number" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration": { - "additionalProperties": false, - "properties": { - "DnsIps": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DomainName": { - "type": "string" - }, - "FileSystemAdministratorsGroup": { - "type": "string" - }, - "OrganizationalUnitDistinguishedName": { - "type": "string" - }, - "Password": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::FSx::FileSystem.WindowsConfiguration": { - "additionalProperties": false, - "properties": { - "ActiveDirectoryId": { - "type": "string" - }, - "Aliases": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AutomaticBackupRetentionDays": { - "type": "number" - }, - "CopyTagsToBackups": { - "type": "boolean" - }, - "DailyAutomaticBackupStartTime": { - "type": "string" - }, - "DeploymentType": { - "type": "string" - }, - "PreferredSubnetId": { - "type": "string" - }, - "SelfManagedActiveDirectoryConfiguration": { - "$ref": "#/definitions/AWS::FSx::FileSystem.SelfManagedActiveDirectoryConfiguration" - }, - "ThroughputCapacity": { - "type": "number" - }, - "WeeklyMaintenanceStartTime": { - "type": "string" - } - }, - "required": [ - "ThroughputCapacity" - ], - "type": "object" - }, - "AWS::GameLift::Alias": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoutingStrategy": { - "$ref": "#/definitions/AWS::GameLift::Alias.RoutingStrategy" - } - }, - "required": [ - "Name", - "RoutingStrategy" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::Alias" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::Alias.RoutingStrategy": { - "additionalProperties": false, - "properties": { - "FleetId": { - "type": "string" - }, - "Message": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::GameLift::Build": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "OperatingSystem": { - "type": "string" - }, - "StorageLocation": { - "$ref": "#/definitions/AWS::GameLift::Build.S3Location" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::Build" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::GameLift::Build.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - }, - "AWS::GameLift::Fleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BuildId": { - "type": "string" - }, - "CertificateConfiguration": { - "$ref": "#/definitions/AWS::GameLift::Fleet.CertificateConfiguration" - }, - "Description": { - "type": "string" - }, - "DesiredEC2Instances": { - "type": "number" - }, - "EC2InboundPermissions": { - "items": { - "$ref": "#/definitions/AWS::GameLift::Fleet.IpPermission" - }, - "type": "array" - }, - "EC2InstanceType": { - "type": "string" - }, - "FleetType": { - "type": "string" - }, - "InstanceRoleARN": { - "type": "string" - }, - "LogPaths": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxSize": { - "type": "number" - }, - "MetricGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MinSize": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "NewGameSessionProtectionPolicy": { - "type": "string" - }, - "PeerVpcAwsAccountId": { - "type": "string" - }, - "PeerVpcId": { - "type": "string" - }, - "ResourceCreationLimitPolicy": { - "$ref": "#/definitions/AWS::GameLift::Fleet.ResourceCreationLimitPolicy" - }, - "RuntimeConfiguration": { - "$ref": "#/definitions/AWS::GameLift::Fleet.RuntimeConfiguration" - }, - "ScriptId": { - "type": "string" - }, - "ServerLaunchParameters": { - "type": "string" - }, - "ServerLaunchPath": { - "type": "string" - } - }, - "required": [ - "EC2InstanceType", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::Fleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::Fleet.CertificateConfiguration": { - "additionalProperties": false, - "properties": { - "CertificateType": { - "type": "string" - } - }, - "required": [ - "CertificateType" - ], - "type": "object" - }, - "AWS::GameLift::Fleet.IpPermission": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "number" - }, - "IpRange": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "FromPort", - "IpRange", - "Protocol", - "ToPort" - ], - "type": "object" - }, - "AWS::GameLift::Fleet.ResourceCreationLimitPolicy": { - "additionalProperties": false, - "properties": { - "NewGameSessionsPerCreator": { - "type": "number" - }, - "PolicyPeriodInMinutes": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::GameLift::Fleet.RuntimeConfiguration": { - "additionalProperties": false, - "properties": { - "GameSessionActivationTimeoutSeconds": { - "type": "number" - }, - "MaxConcurrentGameSessionActivations": { - "type": "number" - }, - "ServerProcesses": { - "items": { - "$ref": "#/definitions/AWS::GameLift::Fleet.ServerProcess" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::GameLift::Fleet.ServerProcess": { - "additionalProperties": false, - "properties": { - "ConcurrentExecutions": { - "type": "number" - }, - "LaunchPath": { - "type": "string" - }, - "Parameters": { - "type": "string" - } - }, - "required": [ - "ConcurrentExecutions", - "LaunchPath" - ], - "type": "object" - }, - "AWS::GameLift::GameServerGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AutoScalingPolicy": { - "$ref": "#/definitions/AWS::GameLift::GameServerGroup.AutoScalingPolicy" - }, - "BalancingStrategy": { - "type": "string" - }, - "DeleteOption": { - "type": "string" - }, - "GameServerGroupName": { - "type": "string" - }, - "GameServerProtectionPolicy": { - "type": "string" - }, - "InstanceDefinitions": { - "items": { - "$ref": "#/definitions/AWS::GameLift::GameServerGroup.InstanceDefinition" - }, - "type": "array" - }, - "LaunchTemplate": { - "$ref": "#/definitions/AWS::GameLift::GameServerGroup.LaunchTemplate" - }, - "MaxSize": { - "type": "number" - }, - "MinSize": { - "type": "number" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcSubnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "GameServerGroupName", - "InstanceDefinitions", - "LaunchTemplate", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::GameServerGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::GameServerGroup.AutoScalingPolicy": { - "additionalProperties": false, - "properties": { - "EstimatedInstanceWarmup": { - "type": "number" - }, - "TargetTrackingConfiguration": { - "$ref": "#/definitions/AWS::GameLift::GameServerGroup.TargetTrackingConfiguration" - } - }, - "required": [ - "TargetTrackingConfiguration" - ], - "type": "object" - }, - "AWS::GameLift::GameServerGroup.InstanceDefinition": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "type": "string" - }, - "WeightedCapacity": { - "type": "string" - } - }, - "required": [ - "InstanceType" - ], - "type": "object" - }, - "AWS::GameLift::GameServerGroup.LaunchTemplate": { - "additionalProperties": false, - "properties": { - "LaunchTemplateId": { - "type": "string" - }, - "LaunchTemplateName": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GameLift::GameServerGroup.TargetTrackingConfiguration": { - "additionalProperties": false, - "properties": { - "TargetValue": { - "type": "number" - } - }, - "required": [ - "TargetValue" - ], - "type": "object" - }, - "AWS::GameLift::GameSessionQueue": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::GameLift::GameSessionQueue.Destination" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "PlayerLatencyPolicies": { - "items": { - "$ref": "#/definitions/AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy" - }, - "type": "array" - }, - "TimeoutInSeconds": { - "type": "number" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::GameSessionQueue" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::GameSessionQueue.Destination": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GameLift::GameSessionQueue.PlayerLatencyPolicy": { - "additionalProperties": false, - "properties": { - "MaximumIndividualPlayerLatencyMilliseconds": { - "type": "number" - }, - "PolicyDurationSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::GameLift::MatchmakingConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptanceRequired": { - "type": "boolean" - }, - "AcceptanceTimeoutSeconds": { - "type": "number" - }, - "AdditionalPlayerCount": { - "type": "number" - }, - "BackfillMode": { - "type": "string" - }, - "CustomEventData": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FlexMatchMode": { - "type": "string" - }, - "GameProperties": { - "items": { - "$ref": "#/definitions/AWS::GameLift::MatchmakingConfiguration.GameProperty" - }, - "type": "array" - }, - "GameSessionData": { - "type": "string" - }, - "GameSessionQueueArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "NotificationTarget": { - "type": "string" - }, - "RequestTimeoutSeconds": { - "type": "number" - }, - "RuleSetName": { - "type": "string" - } - }, - "required": [ - "AcceptanceRequired", - "Name", - "RequestTimeoutSeconds", - "RuleSetName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::MatchmakingConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::MatchmakingConfiguration.GameProperty": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::GameLift::MatchmakingRuleSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RuleSetBody": { - "type": "string" - } - }, - "required": [ - "Name", - "RuleSetBody" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::MatchmakingRuleSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::Script": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "StorageLocation": { - "$ref": "#/definitions/AWS::GameLift::Script.S3Location" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "StorageLocation" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GameLift::Script" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GameLift::Script.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::Accelerator": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "IpAddressType": { - "type": "string" - }, - "IpAddresses": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GlobalAccelerator::Accelerator" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::EndpointGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EndpointConfigurations": { - "items": { - "$ref": "#/definitions/AWS::GlobalAccelerator::EndpointGroup.EndpointConfiguration" - }, - "type": "array" - }, - "EndpointGroupRegion": { - "type": "string" - }, - "HealthCheckIntervalSeconds": { - "type": "number" - }, - "HealthCheckPath": { - "type": "string" - }, - "HealthCheckPort": { - "type": "number" - }, - "HealthCheckProtocol": { - "type": "string" - }, - "ListenerArn": { - "type": "string" - }, - "PortOverrides": { - "items": { - "$ref": "#/definitions/AWS::GlobalAccelerator::EndpointGroup.PortOverride" - }, - "type": "array" - }, - "ThresholdCount": { - "type": "number" - }, - "TrafficDialPercentage": { - "type": "number" - } - }, - "required": [ - "EndpointGroupRegion", - "ListenerArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GlobalAccelerator::EndpointGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::EndpointGroup.EndpointConfiguration": { - "additionalProperties": false, - "properties": { - "ClientIPPreservationEnabled": { - "type": "boolean" - }, - "EndpointId": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "required": [ - "EndpointId" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::EndpointGroup.PortOverride": { - "additionalProperties": false, - "properties": { - "EndpointPort": { - "type": "number" - }, - "ListenerPort": { - "type": "number" - } - }, - "required": [ - "EndpointPort", - "ListenerPort" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::Listener": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceleratorArn": { - "type": "string" - }, - "ClientAffinity": { - "type": "string" - }, - "PortRanges": { - "items": { - "$ref": "#/definitions/AWS::GlobalAccelerator::Listener.PortRange" - }, - "type": "array" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "AcceleratorArn", - "PortRanges", - "Protocol" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GlobalAccelerator::Listener" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GlobalAccelerator::Listener.PortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "number" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "AWS::Glue::Classifier": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CsvClassifier": { - "$ref": "#/definitions/AWS::Glue::Classifier.CsvClassifier" - }, - "GrokClassifier": { - "$ref": "#/definitions/AWS::Glue::Classifier.GrokClassifier" - }, - "JsonClassifier": { - "$ref": "#/definitions/AWS::Glue::Classifier.JsonClassifier" - }, - "XMLClassifier": { - "$ref": "#/definitions/AWS::Glue::Classifier.XMLClassifier" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Classifier" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Glue::Classifier.CsvClassifier": { - "additionalProperties": false, - "properties": { - "AllowSingleColumn": { - "type": "boolean" - }, - "ContainsHeader": { - "type": "string" - }, - "Delimiter": { - "type": "string" - }, - "DisableValueTrimming": { - "type": "boolean" - }, - "Header": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "QuoteSymbol": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Classifier.GrokClassifier": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "CustomPatterns": { - "type": "string" - }, - "GrokPattern": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Classification", - "GrokPattern" - ], - "type": "object" - }, - "AWS::Glue::Classifier.JsonClassifier": { - "additionalProperties": false, - "properties": { - "JsonPath": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "JsonPath" - ], - "type": "object" - }, - "AWS::Glue::Classifier.XMLClassifier": { - "additionalProperties": false, - "properties": { - "Classification": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RowTag": { - "type": "string" - } - }, - "required": [ - "Classification", - "RowTag" - ], - "type": "object" - }, - "AWS::Glue::Connection": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "ConnectionInput": { - "$ref": "#/definitions/AWS::Glue::Connection.ConnectionInput" - } - }, - "required": [ - "CatalogId", - "ConnectionInput" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Connection" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Connection.ConnectionInput": { - "additionalProperties": false, - "properties": { - "ConnectionProperties": { - "type": "object" - }, - "ConnectionType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "MatchCriteria": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "PhysicalConnectionRequirements": { - "$ref": "#/definitions/AWS::Glue::Connection.PhysicalConnectionRequirements" - } - }, - "required": [ - "ConnectionType" - ], - "type": "object" - }, - "AWS::Glue::Connection.PhysicalConnectionRequirements": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "SecurityGroupIdList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Classifiers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Configuration": { - "type": "string" - }, - "CrawlerSecurityConfiguration": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Role": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/AWS::Glue::Crawler.Schedule" - }, - "SchemaChangePolicy": { - "$ref": "#/definitions/AWS::Glue::Crawler.SchemaChangePolicy" - }, - "TablePrefix": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Targets": { - "$ref": "#/definitions/AWS::Glue::Crawler.Targets" - } - }, - "required": [ - "Role", - "Targets" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Crawler" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Crawler.CatalogTarget": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "Tables": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.DynamoDBTarget": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.JdbcTarget": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "Exclusions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.S3Target": { - "additionalProperties": false, - "properties": { - "ConnectionName": { - "type": "string" - }, - "Exclusions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.Schedule": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.SchemaChangePolicy": { - "additionalProperties": false, - "properties": { - "DeleteBehavior": { - "type": "string" - }, - "UpdateBehavior": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Crawler.Targets": { - "additionalProperties": false, - "properties": { - "CatalogTargets": { - "items": { - "$ref": "#/definitions/AWS::Glue::Crawler.CatalogTarget" - }, - "type": "array" - }, - "DynamoDBTargets": { - "items": { - "$ref": "#/definitions/AWS::Glue::Crawler.DynamoDBTarget" - }, - "type": "array" - }, - "JdbcTargets": { - "items": { - "$ref": "#/definitions/AWS::Glue::Crawler.JdbcTarget" - }, - "type": "array" - }, - "S3Targets": { - "items": { - "$ref": "#/definitions/AWS::Glue::Crawler.S3Target" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::DataCatalogEncryptionSettings": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DataCatalogEncryptionSettings": { - "$ref": "#/definitions/AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings" - } - }, - "required": [ - "CatalogId", - "DataCatalogEncryptionSettings" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::DataCatalogEncryptionSettings" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "ReturnConnectionPasswordEncrypted": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Glue::DataCatalogEncryptionSettings.DataCatalogEncryptionSettings": { - "additionalProperties": false, - "properties": { - "ConnectionPasswordEncryption": { - "$ref": "#/definitions/AWS::Glue::DataCatalogEncryptionSettings.ConnectionPasswordEncryption" - }, - "EncryptionAtRest": { - "$ref": "#/definitions/AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest" - } - }, - "type": "object" - }, - "AWS::Glue::DataCatalogEncryptionSettings.EncryptionAtRest": { - "additionalProperties": false, - "properties": { - "CatalogEncryptionMode": { - "type": "string" - }, - "SseAwsKmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Database": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseInput": { - "$ref": "#/definitions/AWS::Glue::Database.DatabaseInput" - } - }, - "required": [ - "CatalogId", - "DatabaseInput" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Database" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Database.DatabaseIdentifier": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Database.DatabaseInput": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "LocationUri": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "TargetDatabase": { - "$ref": "#/definitions/AWS::Glue::Database.DatabaseIdentifier" - } - }, - "type": "object" - }, - "AWS::Glue::DevEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Arguments": { - "type": "object" - }, - "EndpointName": { - "type": "string" - }, - "ExtraJarsS3Path": { - "type": "string" - }, - "ExtraPythonLibsS3Path": { - "type": "string" - }, - "GlueVersion": { - "type": "string" - }, - "NumberOfNodes": { - "type": "number" - }, - "NumberOfWorkers": { - "type": "number" - }, - "PublicKey": { - "type": "string" - }, - "PublicKeys": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RoleArn": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "WorkerType": { - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::DevEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Job": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllocatedCapacity": { - "type": "number" - }, - "Command": { - "$ref": "#/definitions/AWS::Glue::Job.JobCommand" - }, - "Connections": { - "$ref": "#/definitions/AWS::Glue::Job.ConnectionsList" - }, - "DefaultArguments": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "ExecutionProperty": { - "$ref": "#/definitions/AWS::Glue::Job.ExecutionProperty" - }, - "GlueVersion": { - "type": "string" - }, - "LogUri": { - "type": "string" - }, - "MaxCapacity": { - "type": "number" - }, - "MaxRetries": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "NotificationProperty": { - "$ref": "#/definitions/AWS::Glue::Job.NotificationProperty" - }, - "NumberOfWorkers": { - "type": "number" - }, - "Role": { - "type": "string" - }, - "SecurityConfiguration": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "type": "number" - }, - "WorkerType": { - "type": "string" - } - }, - "required": [ - "Command", - "Role" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Job" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Job.ConnectionsList": { - "additionalProperties": false, - "properties": { - "Connections": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::Job.ExecutionProperty": { - "additionalProperties": false, - "properties": { - "MaxConcurrentRuns": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::Job.JobCommand": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "PythonVersion": { - "type": "string" - }, - "ScriptLocation": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Job.NotificationProperty": { - "additionalProperties": false, - "properties": { - "NotifyDelayAfter": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::MLTransform": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GlueVersion": { - "type": "string" - }, - "InputRecordTables": { - "$ref": "#/definitions/AWS::Glue::MLTransform.InputRecordTables" - }, - "MaxCapacity": { - "type": "number" - }, - "MaxRetries": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "NumberOfWorkers": { - "type": "number" - }, - "Role": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Timeout": { - "type": "number" - }, - "TransformEncryption": { - "$ref": "#/definitions/AWS::Glue::MLTransform.TransformEncryption" - }, - "TransformParameters": { - "$ref": "#/definitions/AWS::Glue::MLTransform.TransformParameters" - }, - "WorkerType": { - "type": "string" - } - }, - "required": [ - "InputRecordTables", - "Role", - "TransformParameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::MLTransform" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::MLTransform.FindMatchesParameters": { - "additionalProperties": false, - "properties": { - "AccuracyCostTradeoff": { - "type": "number" - }, - "EnforceProvidedLabels": { - "type": "boolean" - }, - "PrecisionRecallTradeoff": { - "type": "number" - }, - "PrimaryKeyColumnName": { - "type": "string" - } - }, - "required": [ - "PrimaryKeyColumnName" - ], - "type": "object" - }, - "AWS::Glue::MLTransform.GlueTables": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "ConnectionName": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "DatabaseName", - "TableName" - ], - "type": "object" - }, - "AWS::Glue::MLTransform.InputRecordTables": { - "additionalProperties": false, - "properties": { - "GlueTables": { - "items": { - "$ref": "#/definitions/AWS::Glue::MLTransform.GlueTables" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::MLTransform.MLUserDataEncryption": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MLUserDataEncryptionMode": { - "type": "string" - } - }, - "required": [ - "MLUserDataEncryptionMode" - ], - "type": "object" - }, - "AWS::Glue::MLTransform.TransformEncryption": { - "additionalProperties": false, - "properties": { - "MLUserDataEncryption": { - "$ref": "#/definitions/AWS::Glue::MLTransform.MLUserDataEncryption" - }, - "TaskRunSecurityConfigurationName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::MLTransform.TransformParameters": { - "additionalProperties": false, - "properties": { - "FindMatchesParameters": { - "$ref": "#/definitions/AWS::Glue::MLTransform.FindMatchesParameters" - }, - "TransformType": { - "type": "string" - } - }, - "required": [ - "TransformType" - ], - "type": "object" - }, - "AWS::Glue::Partition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "PartitionInput": { - "$ref": "#/definitions/AWS::Glue::Partition.PartitionInput" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "CatalogId", - "DatabaseName", - "PartitionInput", - "TableName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Partition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Partition.Column": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::Glue::Partition.Order": { - "additionalProperties": false, - "properties": { - "Column": { - "type": "string" - }, - "SortOrder": { - "type": "number" - } - }, - "required": [ - "Column" - ], - "type": "object" - }, - "AWS::Glue::Partition.PartitionInput": { - "additionalProperties": false, - "properties": { - "Parameters": { - "type": "object" - }, - "StorageDescriptor": { - "$ref": "#/definitions/AWS::Glue::Partition.StorageDescriptor" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Values" - ], - "type": "object" - }, - "AWS::Glue::Partition.SchemaId": { - "additionalProperties": false, - "properties": { - "RegistryName": { - "type": "string" - }, - "SchemaArn": { - "type": "string" - }, - "SchemaName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Partition.SchemaReference": { - "additionalProperties": false, - "properties": { - "SchameVersionId": { - "type": "string" - }, - "SchemaId": { - "$ref": "#/definitions/AWS::Glue::Partition.SchemaId" - }, - "SchemaVersionNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::Partition.SerdeInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SerializationLibrary": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Partition.SkewedInfo": { - "additionalProperties": false, - "properties": { - "SkewedColumnNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SkewedColumnValueLocationMaps": { - "type": "object" - }, - "SkewedColumnValues": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::Partition.StorageDescriptor": { - "additionalProperties": false, - "properties": { - "BucketColumns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Columns": { - "items": { - "$ref": "#/definitions/AWS::Glue::Partition.Column" - }, - "type": "array" - }, - "Compressed": { - "type": "boolean" - }, - "InputFormat": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "NumberOfBuckets": { - "type": "number" - }, - "OutputFormat": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SchemaReference": { - "$ref": "#/definitions/AWS::Glue::Partition.SchemaReference" - }, - "SerdeInfo": { - "$ref": "#/definitions/AWS::Glue::Partition.SerdeInfo" - }, - "SkewedInfo": { - "$ref": "#/definitions/AWS::Glue::Partition.SkewedInfo" - }, - "SortColumns": { - "items": { - "$ref": "#/definitions/AWS::Glue::Partition.Order" - }, - "type": "array" - }, - "StoredAsSubDirectories": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Glue::Registry": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Registry" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Schema": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CheckpointVersion": { - "$ref": "#/definitions/AWS::Glue::Schema.SchemaVersion" - }, - "Compatibility": { - "type": "string" - }, - "DataFormat": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Registry": { - "$ref": "#/definitions/AWS::Glue::Schema.Registry" - }, - "SchemaDefinition": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Compatibility", - "DataFormat", - "Name", - "SchemaDefinition" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Schema" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Schema.Registry": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Schema.SchemaVersion": { - "additionalProperties": false, - "properties": { - "IsLatest": { - "type": "boolean" - }, - "VersionNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::SchemaVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Schema": { - "$ref": "#/definitions/AWS::Glue::SchemaVersion.Schema" - }, - "SchemaDefinition": { - "type": "string" - } - }, - "required": [ - "Schema", - "SchemaDefinition" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::SchemaVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::SchemaVersion.Schema": { - "additionalProperties": false, - "properties": { - "RegistryName": { - "type": "string" - }, - "SchemaArn": { - "type": "string" - }, - "SchemaName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::SchemaVersionMetadata": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "SchemaVersionId": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "SchemaVersionId", - "Value" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::SchemaVersionMetadata" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::SecurityConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::Glue::SecurityConfiguration.EncryptionConfiguration" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "EncryptionConfiguration", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::SecurityConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::SecurityConfiguration.CloudWatchEncryption": { - "additionalProperties": false, - "properties": { - "CloudWatchEncryptionMode": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::SecurityConfiguration.EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchEncryption": { - "$ref": "#/definitions/AWS::Glue::SecurityConfiguration.CloudWatchEncryption" - }, - "JobBookmarksEncryption": { - "$ref": "#/definitions/AWS::Glue::SecurityConfiguration.JobBookmarksEncryption" - }, - "S3Encryptions": { - "$ref": "#/definitions/AWS::Glue::SecurityConfiguration.S3Encryptions" - } - }, - "type": "object" - }, - "AWS::Glue::SecurityConfiguration.JobBookmarksEncryption": { - "additionalProperties": false, - "properties": { - "JobBookmarksEncryptionMode": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::SecurityConfiguration.S3Encryption": { - "additionalProperties": false, - "properties": { - "KmsKeyArn": { - "type": "string" - }, - "S3EncryptionMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::SecurityConfiguration.S3Encryptions": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::Glue::Table": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "TableInput": { - "$ref": "#/definitions/AWS::Glue::Table.TableInput" - } - }, - "required": [ - "CatalogId", - "DatabaseName", - "TableInput" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Table" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Table.Column": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::Glue::Table.Order": { - "additionalProperties": false, - "properties": { - "Column": { - "type": "string" - }, - "SortOrder": { - "type": "number" - } - }, - "required": [ - "Column", - "SortOrder" - ], - "type": "object" - }, - "AWS::Glue::Table.SchemaId": { - "additionalProperties": false, - "properties": { - "RegistryName": { - "type": "string" - }, - "SchemaArn": { - "type": "string" - }, - "SchemaName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Table.SchemaReference": { - "additionalProperties": false, - "properties": { - "SchameVersionId": { - "type": "string" - }, - "SchemaId": { - "$ref": "#/definitions/AWS::Glue::Table.SchemaId" - }, - "SchemaVersionNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::Table.SerdeInfo": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SerializationLibrary": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Table.SkewedInfo": { - "additionalProperties": false, - "properties": { - "SkewedColumnNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SkewedColumnValueLocationMaps": { - "type": "object" - }, - "SkewedColumnValues": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Glue::Table.StorageDescriptor": { - "additionalProperties": false, - "properties": { - "BucketColumns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Columns": { - "items": { - "$ref": "#/definitions/AWS::Glue::Table.Column" - }, - "type": "array" - }, - "Compressed": { - "type": "boolean" - }, - "InputFormat": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "NumberOfBuckets": { - "type": "number" - }, - "OutputFormat": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "SchemaReference": { - "$ref": "#/definitions/AWS::Glue::Table.SchemaReference" - }, - "SerdeInfo": { - "$ref": "#/definitions/AWS::Glue::Table.SerdeInfo" - }, - "SkewedInfo": { - "$ref": "#/definitions/AWS::Glue::Table.SkewedInfo" - }, - "SortColumns": { - "items": { - "$ref": "#/definitions/AWS::Glue::Table.Order" - }, - "type": "array" - }, - "StoredAsSubDirectories": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Glue::Table.TableIdentifier": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Table.TableInput": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "PartitionKeys": { - "items": { - "$ref": "#/definitions/AWS::Glue::Table.Column" - }, - "type": "array" - }, - "Retention": { - "type": "number" - }, - "StorageDescriptor": { - "$ref": "#/definitions/AWS::Glue::Table.StorageDescriptor" - }, - "TableType": { - "type": "string" - }, - "TargetTable": { - "$ref": "#/definitions/AWS::Glue::Table.TableIdentifier" - }, - "ViewExpandedText": { - "type": "string" - }, - "ViewOriginalText": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Trigger": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::Glue::Trigger.Action" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Predicate": { - "$ref": "#/definitions/AWS::Glue::Trigger.Predicate" - }, - "Schedule": { - "type": "string" - }, - "StartOnCreation": { - "type": "boolean" - }, - "Tags": { - "type": "object" - }, - "Type": { - "type": "string" - }, - "WorkflowName": { - "type": "string" - } - }, - "required": [ - "Actions", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Trigger" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Glue::Trigger.Action": { - "additionalProperties": false, - "properties": { - "Arguments": { - "type": "object" - }, - "CrawlerName": { - "type": "string" - }, - "JobName": { - "type": "string" - }, - "NotificationProperty": { - "$ref": "#/definitions/AWS::Glue::Trigger.NotificationProperty" - }, - "SecurityConfiguration": { - "type": "string" - }, - "Timeout": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::Trigger.Condition": { - "additionalProperties": false, - "properties": { - "CrawlState": { - "type": "string" - }, - "CrawlerName": { - "type": "string" - }, - "JobName": { - "type": "string" - }, - "LogicalOperator": { - "type": "string" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Trigger.NotificationProperty": { - "additionalProperties": false, - "properties": { - "NotifyDelayAfter": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Glue::Trigger.Predicate": { - "additionalProperties": false, - "properties": { - "Conditions": { - "items": { - "$ref": "#/definitions/AWS::Glue::Trigger.Condition" - }, - "type": "array" - }, - "Logical": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Glue::Workflow": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultRunProperties": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Glue::Workflow" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Greengrass::ConnectorDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::ConnectorDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::ConnectorDefinition.Connector": { - "additionalProperties": false, - "properties": { - "ConnectorArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "required": [ - "ConnectorArn", - "Id" - ], - "type": "object" - }, - "AWS::Greengrass::ConnectorDefinition.ConnectorDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Connectors": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::ConnectorDefinition.Connector" - }, - "type": "array" - } - }, - "required": [ - "Connectors" - ], - "type": "object" - }, - "AWS::Greengrass::ConnectorDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectorDefinitionId": { - "type": "string" - }, - "Connectors": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::ConnectorDefinitionVersion.Connector" - }, - "type": "array" - } - }, - "required": [ - "ConnectorDefinitionId", - "Connectors" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::ConnectorDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::ConnectorDefinitionVersion.Connector": { - "additionalProperties": false, - "properties": { - "ConnectorArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "required": [ - "ConnectorArn", - "Id" - ], - "type": "object" - }, - "AWS::Greengrass::CoreDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::CoreDefinition.CoreDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::CoreDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::CoreDefinition.Core": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn", - "Id", - "ThingArn" - ], - "type": "object" - }, - "AWS::Greengrass::CoreDefinition.CoreDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Cores": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::CoreDefinition.Core" - }, - "type": "array" - } - }, - "required": [ - "Cores" - ], - "type": "object" - }, - "AWS::Greengrass::CoreDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CoreDefinitionId": { - "type": "string" - }, - "Cores": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::CoreDefinitionVersion.Core" - }, - "type": "array" - } - }, - "required": [ - "CoreDefinitionId", - "Cores" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::CoreDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::CoreDefinitionVersion.Core": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn", - "Id", - "ThingArn" - ], - "type": "object" - }, - "AWS::Greengrass::DeviceDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::DeviceDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::DeviceDefinition.Device": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn", - "Id", - "ThingArn" - ], - "type": "object" - }, - "AWS::Greengrass::DeviceDefinition.DeviceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Devices": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::DeviceDefinition.Device" - }, - "type": "array" - } - }, - "required": [ - "Devices" - ], - "type": "object" - }, - "AWS::Greengrass::DeviceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeviceDefinitionId": { - "type": "string" - }, - "Devices": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::DeviceDefinitionVersion.Device" - }, - "type": "array" - } - }, - "required": [ - "DeviceDefinitionId", - "Devices" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::DeviceDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::DeviceDefinitionVersion.Device": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "SyncShadow": { - "type": "boolean" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "CertificateArn", - "Id", - "ThingArn" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::FunctionDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.DefaultConfig": { - "additionalProperties": false, - "properties": { - "Execution": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.Execution" - } - }, - "required": [ - "Execution" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.Environment": { - "additionalProperties": false, - "properties": { - "AccessSysfs": { - "type": "boolean" - }, - "Execution": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.Execution" - }, - "ResourceAccessPolicies": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy" - }, - "type": "array" - }, - "Variables": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.Execution": { - "additionalProperties": false, - "properties": { - "IsolationMode": { - "type": "string" - }, - "RunAs": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.RunAs" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.Function": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "FunctionConfiguration": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.FunctionConfiguration" - }, - "Id": { - "type": "string" - } - }, - "required": [ - "FunctionArn", - "FunctionConfiguration", - "Id" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.FunctionConfiguration": { - "additionalProperties": false, - "properties": { - "EncodingType": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.Environment" - }, - "ExecArgs": { - "type": "string" - }, - "Executable": { - "type": "string" - }, - "MemorySize": { - "type": "number" - }, - "Pinned": { - "type": "boolean" - }, - "Timeout": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.FunctionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DefaultConfig": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.DefaultConfig" - }, - "Functions": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.Function" - }, - "type": "array" - } - }, - "required": [ - "Functions" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.ResourceAccessPolicy": { - "additionalProperties": false, - "properties": { - "Permission": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "required": [ - "ResourceId" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinition.RunAs": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "number" - }, - "Uid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultConfig": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig" - }, - "FunctionDefinitionId": { - "type": "string" - }, - "Functions": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.Function" - }, - "type": "array" - } - }, - "required": [ - "FunctionDefinitionId", - "Functions" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::FunctionDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.DefaultConfig": { - "additionalProperties": false, - "properties": { - "Execution": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.Execution" - } - }, - "required": [ - "Execution" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.Environment": { - "additionalProperties": false, - "properties": { - "AccessSysfs": { - "type": "boolean" - }, - "Execution": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.Execution" - }, - "ResourceAccessPolicies": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy" - }, - "type": "array" - }, - "Variables": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.Execution": { - "additionalProperties": false, - "properties": { - "IsolationMode": { - "type": "string" - }, - "RunAs": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.RunAs" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.Function": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "FunctionConfiguration": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration" - }, - "Id": { - "type": "string" - } - }, - "required": [ - "FunctionArn", - "FunctionConfiguration", - "Id" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.FunctionConfiguration": { - "additionalProperties": false, - "properties": { - "EncodingType": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.Environment" - }, - "ExecArgs": { - "type": "string" - }, - "Executable": { - "type": "string" - }, - "MemorySize": { - "type": "number" - }, - "Pinned": { - "type": "boolean" - }, - "Timeout": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.ResourceAccessPolicy": { - "additionalProperties": false, - "properties": { - "Permission": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "required": [ - "ResourceId" - ], - "type": "object" - }, - "AWS::Greengrass::FunctionDefinitionVersion.RunAs": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "number" - }, - "Uid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Greengrass::Group": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::Group.GroupVersion" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::Group" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::Group.GroupVersion": { - "additionalProperties": false, - "properties": { - "ConnectorDefinitionVersionArn": { - "type": "string" - }, - "CoreDefinitionVersionArn": { - "type": "string" - }, - "DeviceDefinitionVersionArn": { - "type": "string" - }, - "FunctionDefinitionVersionArn": { - "type": "string" - }, - "LoggerDefinitionVersionArn": { - "type": "string" - }, - "ResourceDefinitionVersionArn": { - "type": "string" - }, - "SubscriptionDefinitionVersionArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Greengrass::GroupVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectorDefinitionVersionArn": { - "type": "string" - }, - "CoreDefinitionVersionArn": { - "type": "string" - }, - "DeviceDefinitionVersionArn": { - "type": "string" - }, - "FunctionDefinitionVersionArn": { - "type": "string" - }, - "GroupId": { - "type": "string" - }, - "LoggerDefinitionVersionArn": { - "type": "string" - }, - "ResourceDefinitionVersionArn": { - "type": "string" - }, - "SubscriptionDefinitionVersionArn": { - "type": "string" - } - }, - "required": [ - "GroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::GroupVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::LoggerDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::LoggerDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::LoggerDefinition.Logger": { - "additionalProperties": false, - "properties": { - "Component": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "Space": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Component", - "Id", - "Level", - "Type" - ], - "type": "object" - }, - "AWS::Greengrass::LoggerDefinition.LoggerDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Loggers": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::LoggerDefinition.Logger" - }, - "type": "array" - } - }, - "required": [ - "Loggers" - ], - "type": "object" - }, - "AWS::Greengrass::LoggerDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LoggerDefinitionId": { - "type": "string" - }, - "Loggers": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::LoggerDefinitionVersion.Logger" - }, - "type": "array" - } - }, - "required": [ - "LoggerDefinitionId", - "Loggers" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::LoggerDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::LoggerDefinitionVersion.Logger": { - "additionalProperties": false, - "properties": { - "Component": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "Space": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Component", - "Id", - "Level", - "Type" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::ResourceDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.GroupOwnerSetting": { - "additionalProperties": false, - "properties": { - "AutoAddGroupOwner": { - "type": "boolean" - }, - "GroupOwner": { - "type": "string" - } - }, - "required": [ - "AutoAddGroupOwner" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData": { - "additionalProperties": false, - "properties": { - "GroupOwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "GroupOwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SourcePath" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.ResourceDataContainer": { - "additionalProperties": false, - "properties": { - "LocalDeviceResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.LocalDeviceResourceData" - }, - "LocalVolumeResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.LocalVolumeResourceData" - }, - "S3MachineLearningModelResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData" - }, - "SageMakerMachineLearningModelResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData" - }, - "SecretsManagerSecretResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData" - } - }, - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.ResourceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Resources": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceInstance" - }, - "type": "array" - } - }, - "required": [ - "Resources" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting": { - "additionalProperties": false, - "properties": { - "GroupOwner": { - "type": "string" - }, - "GroupPermission": { - "type": "string" - } - }, - "required": [ - "GroupOwner", - "GroupPermission" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.ResourceInstance": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceDataContainer": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDataContainer" - } - }, - "required": [ - "Id", - "Name", - "ResourceDataContainer" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.S3MachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.SageMakerMachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting" - }, - "SageMakerJobArn": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SageMakerJobArn" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinition.SecretsManagerSecretResourceData": { - "additionalProperties": false, - "properties": { - "ARN": { - "type": "string" - }, - "AdditionalStagingLabelsToDownload": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ARN" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceDefinitionId": { - "type": "string" - }, - "Resources": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance" - }, - "type": "array" - } - }, - "required": [ - "ResourceDefinitionId", - "Resources" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::ResourceDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting": { - "additionalProperties": false, - "properties": { - "AutoAddGroupOwner": { - "type": "boolean" - }, - "GroupOwner": { - "type": "string" - } - }, - "required": [ - "AutoAddGroupOwner" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData": { - "additionalProperties": false, - "properties": { - "GroupOwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "SourcePath" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "GroupOwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.GroupOwnerSetting" - }, - "SourcePath": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SourcePath" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer": { - "additionalProperties": false, - "properties": { - "LocalDeviceResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.LocalDeviceResourceData" - }, - "LocalVolumeResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.LocalVolumeResourceData" - }, - "S3MachineLearningModelResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData" - }, - "SageMakerMachineLearningModelResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData" - }, - "SecretsManagerSecretResourceData": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData" - } - }, - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting": { - "additionalProperties": false, - "properties": { - "GroupOwner": { - "type": "string" - }, - "GroupPermission": { - "type": "string" - } - }, - "required": [ - "GroupOwner", - "GroupPermission" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.ResourceInstance": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceDataContainer": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDataContainer" - } - }, - "required": [ - "Id", - "Name", - "ResourceDataContainer" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.S3MachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.SageMakerMachineLearningModelResourceData": { - "additionalProperties": false, - "properties": { - "DestinationPath": { - "type": "string" - }, - "OwnerSetting": { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting" - }, - "SageMakerJobArn": { - "type": "string" - } - }, - "required": [ - "DestinationPath", - "SageMakerJobArn" - ], - "type": "object" - }, - "AWS::Greengrass::ResourceDefinitionVersion.SecretsManagerSecretResourceData": { - "additionalProperties": false, - "properties": { - "ARN": { - "type": "string" - }, - "AdditionalStagingLabelsToDownload": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ARN" - ], - "type": "object" - }, - "AWS::Greengrass::SubscriptionDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InitialVersion": { - "$ref": "#/definitions/AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::SubscriptionDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::SubscriptionDefinition.Subscription": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Id", - "Source", - "Subject", - "Target" - ], - "type": "object" - }, - "AWS::Greengrass::SubscriptionDefinition.SubscriptionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "Subscriptions": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::SubscriptionDefinition.Subscription" - }, - "type": "array" - } - }, - "required": [ - "Subscriptions" - ], - "type": "object" - }, - "AWS::Greengrass::SubscriptionDefinitionVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SubscriptionDefinitionId": { - "type": "string" - }, - "Subscriptions": { - "items": { - "$ref": "#/definitions/AWS::Greengrass::SubscriptionDefinitionVersion.Subscription" - }, - "type": "array" - } - }, - "required": [ - "SubscriptionDefinitionId", - "Subscriptions" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Greengrass::SubscriptionDefinitionVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Greengrass::SubscriptionDefinitionVersion.Subscription": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Id", - "Source", - "Subject", - "Target" - ], - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InlineRecipe": { - "type": "string" - }, - "LambdaFunction": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaFunctionRecipeSource" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GreengrassV2::ComponentVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.ComponentDependencyRequirement": { - "additionalProperties": false, - "properties": { - "DependencyType": { - "type": "string" - }, - "VersionRequirement": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.ComponentPlatform": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaContainerParams": { - "additionalProperties": false, - "properties": { - "Devices": { - "items": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaDeviceMount" - }, - "type": "array" - }, - "MemorySizeInKB": { - "type": "number" - }, - "MountROSysfs": { - "type": "boolean" - }, - "Volumes": { - "items": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaVolumeMount" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaDeviceMount": { - "additionalProperties": false, - "properties": { - "AddGroupOwner": { - "type": "boolean" - }, - "Path": { - "type": "string" - }, - "Permission": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaEventSource": { - "additionalProperties": false, - "properties": { - "Topic": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters": { - "additionalProperties": false, - "properties": { - "EnvironmentVariables": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "EventSources": { - "items": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaEventSource" - }, - "type": "array" - }, - "ExecArgs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "InputPayloadEncodingType": { - "type": "string" - }, - "LinuxProcessParams": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaLinuxProcessParams" - }, - "MaxIdleTimeInSeconds": { - "type": "number" - }, - "MaxInstancesCount": { - "type": "number" - }, - "MaxQueueSize": { - "type": "number" - }, - "Pinned": { - "type": "boolean" - }, - "StatusTimeoutInSeconds": { - "type": "number" - }, - "TimeoutInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaFunctionRecipeSource": { - "additionalProperties": false, - "properties": { - "ComponentDependencies": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.ComponentDependencyRequirement" - } - }, - "type": "object" - }, - "ComponentLambdaParameters": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters" - }, - "ComponentName": { - "type": "string" - }, - "ComponentPlatforms": { - "items": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.ComponentPlatform" - }, - "type": "array" - }, - "ComponentVersion": { - "type": "string" - }, - "LambdaArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaLinuxProcessParams": { - "additionalProperties": false, - "properties": { - "ContainerParams": { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaContainerParams" - }, - "IsolationMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GreengrassV2::ComponentVersion.LambdaVolumeMount": { - "additionalProperties": false, - "properties": { - "AddGroupOwner": { - "type": "boolean" - }, - "DestinationPath": { - "type": "string" - }, - "Permission": { - "type": "string" - }, - "SourcePath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::GuardDuty::Detector": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataSources": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNDataSourceConfigurations" - }, - "Enable": { - "type": "boolean" - }, - "FindingPublishingFrequency": { - "type": "string" - } - }, - "required": [ - "Enable" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::Detector" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GuardDuty::Detector.CFNDataSourceConfigurations": { - "additionalProperties": false, - "properties": { - "S3Logs": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNS3LogsConfiguration" - } - }, - "type": "object" - }, - "AWS::GuardDuty::Detector.CFNS3LogsConfiguration": { - "additionalProperties": false, - "properties": { - "Enable": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::GuardDuty::Filter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DetectorId": { - "type": "string" - }, - "FindingCriteria": { - "$ref": "#/definitions/AWS::GuardDuty::Filter.FindingCriteria" - }, - "Name": { - "type": "string" - }, - "Rank": { - "type": "number" - } - }, - "required": [ - "Action", - "Description", - "DetectorId", - "FindingCriteria", - "Name", - "Rank" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::Filter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GuardDuty::Filter.Condition": { - "additionalProperties": false, - "properties": { - "Eq": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Gte": { - "type": "number" - }, - "Lt": { - "type": "number" - }, - "Lte": { - "type": "number" - }, - "Neq": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::GuardDuty::Filter.FindingCriteria": { - "additionalProperties": false, - "properties": { - "Criterion": { - "type": "object" - }, - "ItemType": { - "$ref": "#/definitions/AWS::GuardDuty::Filter.Condition" - } - }, - "type": "object" - }, - "AWS::GuardDuty::IPSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Activate": { - "type": "boolean" - }, - "DetectorId": { - "type": "string" - }, - "Format": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Activate", - "DetectorId", - "Format", - "Location" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::IPSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GuardDuty::Master": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DetectorId": { - "type": "string" - }, - "InvitationId": { - "type": "string" - }, - "MasterId": { - "type": "string" - } - }, - "required": [ - "DetectorId", - "MasterId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::Master" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GuardDuty::Member": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DetectorId": { - "type": "string" - }, - "DisableEmailNotification": { - "type": "boolean" - }, - "Email": { - "type": "string" - }, - "MemberId": { - "type": "string" - }, - "Message": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "DetectorId", - "Email", - "MemberId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::Member" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::GuardDuty::ThreatIntelSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Activate": { - "type": "boolean" - }, - "DetectorId": { - "type": "string" - }, - "Format": { - "type": "string" - }, - "Location": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Activate", - "DetectorId", - "Format", - "Location" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::GuardDuty::ThreatIntelSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::AccessKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Serial": { - "type": "number" - }, - "Status": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "required": [ - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::AccessKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::Group": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupName": { - "type": "string" - }, - "ManagedPolicyArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Path": { - "type": "string" - }, - "Policies": { - "items": { - "$ref": "#/definitions/AWS::IAM::Group.Policy" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::Group" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IAM::Group.Policy": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "PolicyName" - ], - "type": "object" - }, - "AWS::IAM::InstanceProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InstanceProfileName": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "Roles": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Roles" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::InstanceProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::ManagedPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ManagedPolicyName": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "PolicyDocument": { - "type": "object" - }, - "Roles": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "PolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::ManagedPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::OIDCProvider": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ClientIdList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThumbprintList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "ThumbprintList" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::OIDCProvider" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::Policy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PolicyDocument": { - "type": "object" - }, - "PolicyName": { - "type": "string" - }, - "Roles": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "PolicyDocument", - "PolicyName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::Policy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::Role": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssumeRolePolicyDocument": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "ManagedPolicyArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxSessionDuration": { - "type": "number" - }, - "Path": { - "type": "string" - }, - "PermissionsBoundary": { - "type": "string" - }, - "Policies": { - "items": { - "$ref": "#/definitions/AWS::IAM::Role.Policy" - }, - "type": "array" - }, - "RoleName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AssumeRolePolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::Role" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::Role.Policy": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "PolicyName" - ], - "type": "object" - }, - "AWS::IAM::SAMLProvider": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SamlMetadataDocument": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "SamlMetadataDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::SAMLProvider" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::ServerCertificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CertificateBody": { - "type": "string" - }, - "CertificateChain": { - "type": "string" - }, - "Path": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - }, - "ServerCertificateName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::ServerCertificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IAM::ServiceLinkedRole": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AWSServiceName": { - "type": "string" - }, - "CustomSuffix": { - "type": "string" - }, - "Description": { - "type": "string" - } - }, - "required": [ - "AWSServiceName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::ServiceLinkedRole" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::User": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Groups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "LoginProfile": { - "$ref": "#/definitions/AWS::IAM::User.LoginProfile" - }, - "ManagedPolicyArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Path": { - "type": "string" - }, - "PermissionsBoundary": { - "type": "string" - }, - "Policies": { - "items": { - "$ref": "#/definitions/AWS::IAM::User.Policy" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::User" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IAM::User.LoginProfile": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "PasswordResetRequired": { - "type": "boolean" - } - }, - "required": [ - "Password" - ], - "type": "object" - }, - "AWS::IAM::User.Policy": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "PolicyDocument", - "PolicyName" - ], - "type": "object" - }, - "AWS::IAM::UserToGroupAddition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GroupName": { - "type": "string" - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "GroupName", - "Users" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::UserToGroupAddition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IAM::VirtualMFADevice": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Users": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VirtualMfaDeviceName": { - "type": "string" - } - }, - "required": [ - "Users" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IAM::VirtualMFADevice" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IVS::Channel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Authorized": { - "type": "boolean" - }, - "LatencyMode": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IVS::Channel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IVS::PlaybackKeyPair": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "PublicKeyMaterial": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PublicKeyMaterial" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IVS::PlaybackKeyPair" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IVS::StreamKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ChannelArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ChannelArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IVS::StreamKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::Component": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ChangeDescription": { - "type": "string" - }, - "Data": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Platform": { - "type": "string" - }, - "SupportedOsVersions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Uri": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Name", - "Platform", - "Version" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::Component" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::ContainerRecipe": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Components": { - "items": { - "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration" - }, - "type": "array" - }, - "ContainerType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DockerfileTemplateData": { - "type": "string" - }, - "DockerfileTemplateUri": { - "type": "string" - }, - "ImageOsVersionOverride": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ParentImage": { - "type": "string" - }, - "PlatformOverride": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "TargetRepository": { - "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.TargetContainerRepository" - }, - "Version": { - "type": "string" - }, - "WorkingDirectory": { - "type": "string" - } - }, - "required": [ - "Components", - "ContainerType", - "Name", - "ParentImage", - "TargetRepository", - "Version" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::ContainerRecipe" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration": { - "additionalProperties": false, - "properties": { - "ComponentArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ContainerRecipe.TargetContainerRepository": { - "additionalProperties": false, - "properties": { - "RepositoryName": { - "type": "string" - }, - "Service": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::DistributionConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Distributions": { - "items": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.Distribution" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "Distributions", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::DistributionConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::DistributionConfiguration.Distribution": { - "additionalProperties": false, - "properties": { - "AmiDistributionConfiguration": { - "type": "object" - }, - "ContainerDistributionConfiguration": { - "type": "object" - }, - "LicenseConfigurationArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Region": { - "type": "string" - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "AWS::ImageBuilder::Image": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContainerRecipeArn": { - "type": "string" - }, - "DistributionConfigurationArn": { - "type": "string" - }, - "EnhancedImageMetadataEnabled": { - "type": "boolean" - }, - "ImageRecipeArn": { - "type": "string" - }, - "ImageTestsConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageTestsConfiguration" - }, - "InfrastructureConfigurationArn": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "InfrastructureConfigurationArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::Image" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::Image.ImageTestsConfiguration": { - "additionalProperties": false, - "properties": { - "ImageTestsEnabled": { - "type": "boolean" - }, - "TimeoutMinutes": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ImagePipeline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContainerRecipeArn": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DistributionConfigurationArn": { - "type": "string" - }, - "EnhancedImageMetadataEnabled": { - "type": "boolean" - }, - "ImageRecipeArn": { - "type": "string" - }, - "ImageTestsConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration" - }, - "InfrastructureConfigurationArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.Schedule" - }, - "Status": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "InfrastructureConfigurationArn", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::ImagePipeline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration": { - "additionalProperties": false, - "properties": { - "ImageTestsEnabled": { - "type": "boolean" - }, - "TimeoutMinutes": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ImagePipeline.Schedule": { - "additionalProperties": false, - "properties": { - "PipelineExecutionStartCondition": { - "type": "string" - }, - "ScheduleExpression": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ImageRecipe": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe.InstanceBlockDeviceMapping" - }, - "type": "array" - }, - "Components": { - "items": { - "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe.ComponentConfiguration" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ParentImage": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Version": { - "type": "string" - }, - "WorkingDirectory": { - "type": "string" - } - }, - "required": [ - "Components", - "Name", - "ParentImage", - "Version" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::ImageRecipe" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::ImageRecipe.ComponentConfiguration": { - "additionalProperties": false, - "properties": { - "ComponentArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ImageRecipe.EbsInstanceBlockDeviceSpecification": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::ImageRecipe.InstanceBlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe.EbsInstanceBlockDeviceSpecification" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::InfrastructureConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InstanceProfileName": { - "type": "string" - }, - "InstanceTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "KeyPair": { - "type": "string" - }, - "Logging": { - "type": "object" - }, - "Name": { - "type": "string" - }, - "ResourceTags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnsTopicArn": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "TerminateInstanceOnFailure": { - "type": "boolean" - } - }, - "required": [ - "InstanceProfileName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ImageBuilder::InfrastructureConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ImageBuilder::InfrastructureConfiguration.Logging": { - "additionalProperties": false, - "properties": { - "S3Logs": { - "$ref": "#/definitions/AWS::ImageBuilder::InfrastructureConfiguration.S3Logs" - } - }, - "type": "object" - }, - "AWS::ImageBuilder::InfrastructureConfiguration.S3Logs": { - "additionalProperties": false, - "properties": { - "S3BucketName": { - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Inspector::AssessmentTarget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssessmentTargetName": { - "type": "string" - }, - "ResourceGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Inspector::AssessmentTarget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Inspector::AssessmentTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssessmentTargetArn": { - "type": "string" - }, - "AssessmentTemplateName": { - "type": "string" - }, - "DurationInSeconds": { - "type": "number" - }, - "RulesPackageArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UserAttributesForFindings": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AssessmentTargetArn", - "DurationInSeconds", - "RulesPackageArns" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Inspector::AssessmentTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Inspector::ResourceGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceGroupTags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ResourceGroupTags" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Inspector::ResourceGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT1Click::Device": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeviceId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "DeviceId", - "Enabled" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT1Click::Device" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT1Click::Placement": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssociatedDevices": { - "type": "object" - }, - "Attributes": { - "type": "object" - }, - "PlacementName": { - "type": "string" - }, - "ProjectName": { - "type": "string" - } - }, - "required": [ - "ProjectName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT1Click::Placement" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT1Click::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "PlacementTemplate": { - "$ref": "#/definitions/AWS::IoT1Click::Project.PlacementTemplate" - }, - "ProjectName": { - "type": "string" - } - }, - "required": [ - "PlacementTemplate" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT1Click::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT1Click::Project.DeviceTemplate": { - "additionalProperties": false, - "properties": { - "CallbackOverrides": { - "type": "object" - }, - "DeviceType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT1Click::Project.PlacementTemplate": { - "additionalProperties": false, - "properties": { - "DefaultAttributes": { - "type": "object" - }, - "DeviceTemplates": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::IoT::AccountAuditConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccountId": { - "type": "string" - }, - "AuditCheckConfigurations": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfigurations" - }, - "AuditNotificationTargetConfigurations": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditNotificationTargetConfigurations" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "AccountId", - "AuditCheckConfigurations", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::AccountAuditConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoT::AccountAuditConfiguration.AuditCheckConfigurations": { - "additionalProperties": false, - "properties": { - "AuthenticatedCognitoRoleOverlyPermissiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "CaCertificateExpiringCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "CaCertificateKeyQualityCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "ConflictingClientIdsCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "DeviceCertificateExpiringCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "DeviceCertificateKeyQualityCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "DeviceCertificateSharedCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "IotPolicyOverlyPermissiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "IotRoleAliasAllowsAccessToUnusedServicesCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "IotRoleAliasOverlyPermissiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "LoggingDisabledCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "RevokedCaCertificateStillActiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "RevokedDeviceCertificateStillActiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - }, - "UnauthenticatedCognitoRoleOverlyPermissiveCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" - } - }, - "type": "object" - }, - "AWS::IoT::AccountAuditConfiguration.AuditNotificationTarget": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "RoleArn": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::AccountAuditConfiguration.AuditNotificationTargetConfigurations": { - "additionalProperties": false, - "properties": { - "Sns": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditNotificationTarget" - } - }, - "type": "object" - }, - "AWS::IoT::Authorizer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthorizerFunctionArn": { - "type": "string" - }, - "AuthorizerName": { - "type": "string" - }, - "SigningDisabled": { - "type": "boolean" - }, - "Status": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TokenKeyName": { - "type": "string" - }, - "TokenSigningPublicKeys": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "AuthorizerFunctionArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::Authorizer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::Certificate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CACertificatePem": { - "type": "string" - }, - "CertificateMode": { - "type": "string" - }, - "CertificatePem": { - "type": "string" - }, - "CertificateSigningRequest": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::Certificate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::CustomMetric": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DisplayName": { - "type": "string" - }, - "MetricName": { - "type": "string" - }, - "MetricType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "MetricType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::CustomMetric" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::Dimension": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "StringValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "StringValues", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::Dimension" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::DomainConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthorizerConfig": { - "$ref": "#/definitions/AWS::IoT::DomainConfiguration.AuthorizerConfig" - }, - "DomainConfigurationName": { - "type": "string" - }, - "DomainConfigurationStatus": { - "type": "string" - }, - "DomainName": { - "type": "string" - }, - "ServerCertificateArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ServiceType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ValidationCertificateArn": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::DomainConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoT::DomainConfiguration.AuthorizerConfig": { - "additionalProperties": false, - "properties": { - "AllowAuthorizerOverride": { - "type": "boolean" - }, - "DefaultAuthorizerName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::DomainConfiguration.ServerCertificateSummary": { - "additionalProperties": false, - "properties": { - "ServerCertificateArn": { - "type": "string" - }, - "ServerCertificateStatus": { - "type": "string" - }, - "ServerCertificateStatusDetail": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::MitigationAction": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ActionName": { - "type": "string" - }, - "ActionParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.ActionParams" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ActionParams", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::MitigationAction" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.ActionParams": { - "additionalProperties": false, - "properties": { - "AddThingsToThingGroupParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.AddThingsToThingGroupParams" - }, - "EnableIoTLoggingParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.EnableIoTLoggingParams" - }, - "PublishFindingToSnsParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.PublishFindingToSnsParams" - }, - "ReplaceDefaultPolicyVersionParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.ReplaceDefaultPolicyVersionParams" - }, - "UpdateCACertificateParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.UpdateCACertificateParams" - }, - "UpdateDeviceCertificateParams": { - "$ref": "#/definitions/AWS::IoT::MitigationAction.UpdateDeviceCertificateParams" - } - }, - "type": "object" - }, - "AWS::IoT::MitigationAction.AddThingsToThingGroupParams": { - "additionalProperties": false, - "properties": { - "OverrideDynamicGroups": { - "type": "boolean" - }, - "ThingGroupNames": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ThingGroupNames" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.EnableIoTLoggingParams": { - "additionalProperties": false, - "properties": { - "LogLevel": { - "type": "string" - }, - "RoleArnForLogging": { - "type": "string" - } - }, - "required": [ - "LogLevel", - "RoleArnForLogging" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.PublishFindingToSnsParams": { - "additionalProperties": false, - "properties": { - "TopicArn": { - "type": "string" - } - }, - "required": [ - "TopicArn" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.ReplaceDefaultPolicyVersionParams": { - "additionalProperties": false, - "properties": { - "TemplateName": { - "type": "string" - } - }, - "required": [ - "TemplateName" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.UpdateCACertificateParams": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "AWS::IoT::MitigationAction.UpdateDeviceCertificateParams": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "AWS::IoT::Policy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "PolicyName": { - "type": "string" - } - }, - "required": [ - "PolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::Policy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::PolicyPrincipalAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyName": { - "type": "string" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "PolicyName", - "Principal" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::PolicyPrincipalAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::ProvisioningTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PreProvisioningHook": { - "$ref": "#/definitions/AWS::IoT::ProvisioningTemplate.ProvisioningHook" - }, - "ProvisioningRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TemplateBody": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "required": [ - "ProvisioningRoleArn", - "TemplateBody" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::ProvisioningTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::ProvisioningTemplate.ProvisioningHook": { - "additionalProperties": false, - "properties": { - "PayloadVersion": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::ScheduledAudit": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DayOfMonth": { - "type": "string" - }, - "DayOfWeek": { - "type": "string" - }, - "Frequency": { - "type": "string" - }, - "ScheduledAuditName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetCheckNames": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Frequency", - "TargetCheckNames" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::ScheduledAudit" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdditionalMetricsToRetainV2": { - "items": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.MetricToRetain" - }, - "type": "array" - }, - "AlertTargets": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.AlertTarget" - } - }, - "type": "object" - }, - "Behaviors": { - "items": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.Behavior" - }, - "type": "array" - }, - "SecurityProfileDescription": { - "type": "string" - }, - "SecurityProfileName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::SecurityProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile.AlertTarget": { - "additionalProperties": false, - "properties": { - "AlertTargetArn": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "AlertTargetArn", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile.Behavior": { - "additionalProperties": false, - "properties": { - "Criteria": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.BehaviorCriteria" - }, - "Metric": { - "type": "string" - }, - "MetricDimension": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.MetricDimension" - }, - "Name": { - "type": "string" - }, - "SuppressAlerts": { - "type": "boolean" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile.BehaviorCriteria": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "ConsecutiveDatapointsToAlarm": { - "type": "number" - }, - "ConsecutiveDatapointsToClear": { - "type": "number" - }, - "DurationSeconds": { - "type": "number" - }, - "MlDetectionConfig": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.MachineLearningDetectionConfig" - }, - "StatisticalThreshold": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.StatisticalThreshold" - }, - "Value": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.MetricValue" - } - }, - "type": "object" - }, - "AWS::IoT::SecurityProfile.MachineLearningDetectionConfig": { - "additionalProperties": false, - "properties": { - "ConfidenceLevel": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::SecurityProfile.MetricDimension": { - "additionalProperties": false, - "properties": { - "DimensionName": { - "type": "string" - }, - "Operator": { - "type": "string" - } - }, - "required": [ - "DimensionName" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile.MetricToRetain": { - "additionalProperties": false, - "properties": { - "Metric": { - "type": "string" - }, - "MetricDimension": { - "$ref": "#/definitions/AWS::IoT::SecurityProfile.MetricDimension" - } - }, - "required": [ - "Metric" - ], - "type": "object" - }, - "AWS::IoT::SecurityProfile.MetricValue": { - "additionalProperties": false, - "properties": { - "Cidrs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Count": { - "type": "string" - }, - "Number": { - "type": "number" - }, - "Numbers": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Ports": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Strings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoT::SecurityProfile.StatisticalThreshold": { - "additionalProperties": false, - "properties": { - "Statistic": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::Thing": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AttributePayload": { - "$ref": "#/definitions/AWS::IoT::Thing.AttributePayload" - }, - "ThingName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::Thing" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoT::Thing.AttributePayload": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::IoT::ThingPrincipalAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Principal": { - "type": "string" - }, - "ThingName": { - "type": "string" - } - }, - "required": [ - "Principal", - "ThingName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::ThingPrincipalAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::TopicRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RuleName": { - "type": "string" - }, - "TopicRulePayload": { - "$ref": "#/definitions/AWS::IoT::TopicRule.TopicRulePayload" - } - }, - "required": [ - "TopicRulePayload" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::TopicRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.Action": { - "additionalProperties": false, - "properties": { - "CloudwatchAlarm": { - "$ref": "#/definitions/AWS::IoT::TopicRule.CloudwatchAlarmAction" - }, - "CloudwatchMetric": { - "$ref": "#/definitions/AWS::IoT::TopicRule.CloudwatchMetricAction" - }, - "DynamoDB": { - "$ref": "#/definitions/AWS::IoT::TopicRule.DynamoDBAction" - }, - "DynamoDBv2": { - "$ref": "#/definitions/AWS::IoT::TopicRule.DynamoDBv2Action" - }, - "Elasticsearch": { - "$ref": "#/definitions/AWS::IoT::TopicRule.ElasticsearchAction" - }, - "Firehose": { - "$ref": "#/definitions/AWS::IoT::TopicRule.FirehoseAction" - }, - "Http": { - "$ref": "#/definitions/AWS::IoT::TopicRule.HttpAction" - }, - "IotAnalytics": { - "$ref": "#/definitions/AWS::IoT::TopicRule.IotAnalyticsAction" - }, - "IotEvents": { - "$ref": "#/definitions/AWS::IoT::TopicRule.IotEventsAction" - }, - "IotSiteWise": { - "$ref": "#/definitions/AWS::IoT::TopicRule.IotSiteWiseAction" - }, - "Kinesis": { - "$ref": "#/definitions/AWS::IoT::TopicRule.KinesisAction" - }, - "Lambda": { - "$ref": "#/definitions/AWS::IoT::TopicRule.LambdaAction" - }, - "Republish": { - "$ref": "#/definitions/AWS::IoT::TopicRule.RepublishAction" - }, - "S3": { - "$ref": "#/definitions/AWS::IoT::TopicRule.S3Action" - }, - "Sns": { - "$ref": "#/definitions/AWS::IoT::TopicRule.SnsAction" - }, - "Sqs": { - "$ref": "#/definitions/AWS::IoT::TopicRule.SqsAction" - }, - "StepFunctions": { - "$ref": "#/definitions/AWS::IoT::TopicRule.StepFunctionsAction" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRule.AssetPropertyTimestamp": { - "additionalProperties": false, - "properties": { - "OffsetInNanos": { - "type": "string" - }, - "TimeInSeconds": { - "type": "string" - } - }, - "required": [ - "TimeInSeconds" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.AssetPropertyValue": { - "additionalProperties": false, - "properties": { - "Quality": { - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/AWS::IoT::TopicRule.AssetPropertyTimestamp" - }, - "Value": { - "$ref": "#/definitions/AWS::IoT::TopicRule.AssetPropertyVariant" - } - }, - "required": [ - "Timestamp", - "Value" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.AssetPropertyVariant": { - "additionalProperties": false, - "properties": { - "BooleanValue": { - "type": "string" - }, - "DoubleValue": { - "type": "string" - }, - "IntegerValue": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRule.CloudwatchAlarmAction": { - "additionalProperties": false, - "properties": { - "AlarmName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StateReason": { - "type": "string" - }, - "StateValue": { - "type": "string" - } - }, - "required": [ - "AlarmName", - "RoleArn", - "StateReason", - "StateValue" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.CloudwatchMetricAction": { - "additionalProperties": false, - "properties": { - "MetricName": { - "type": "string" - }, - "MetricNamespace": { - "type": "string" - }, - "MetricTimestamp": { - "type": "string" - }, - "MetricUnit": { - "type": "string" - }, - "MetricValue": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "MetricName", - "MetricNamespace", - "MetricUnit", - "MetricValue", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.DynamoDBAction": { - "additionalProperties": false, - "properties": { - "HashKeyField": { - "type": "string" - }, - "HashKeyType": { - "type": "string" - }, - "HashKeyValue": { - "type": "string" - }, - "PayloadField": { - "type": "string" - }, - "RangeKeyField": { - "type": "string" - }, - "RangeKeyType": { - "type": "string" - }, - "RangeKeyValue": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "HashKeyField", - "HashKeyValue", - "RoleArn", - "TableName" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.DynamoDBv2Action": { - "additionalProperties": false, - "properties": { - "PutItem": { - "$ref": "#/definitions/AWS::IoT::TopicRule.PutItemInput" - }, - "RoleArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRule.ElasticsearchAction": { - "additionalProperties": false, - "properties": { - "Endpoint": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Index": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Endpoint", - "Id", - "Index", - "RoleArn", - "Type" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.FirehoseAction": { - "additionalProperties": false, - "properties": { - "DeliveryStreamName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Separator": { - "type": "string" - } - }, - "required": [ - "DeliveryStreamName", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.HttpAction": { - "additionalProperties": false, - "properties": { - "Auth": { - "$ref": "#/definitions/AWS::IoT::TopicRule.HttpAuthorization" - }, - "ConfirmationUrl": { - "type": "string" - }, - "Headers": { - "items": { - "$ref": "#/definitions/AWS::IoT::TopicRule.HttpActionHeader" - }, - "type": "array" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Url" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.HttpActionHeader": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.HttpAuthorization": { - "additionalProperties": false, - "properties": { - "Sigv4": { - "$ref": "#/definitions/AWS::IoT::TopicRule.SigV4Authorization" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRule.IotAnalyticsAction": { - "additionalProperties": false, - "properties": { - "ChannelName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "ChannelName", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.IotEventsAction": { - "additionalProperties": false, - "properties": { - "InputName": { - "type": "string" - }, - "MessageId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "InputName", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.IotSiteWiseAction": { - "additionalProperties": false, - "properties": { - "PutAssetPropertyValueEntries": { - "items": { - "$ref": "#/definitions/AWS::IoT::TopicRule.PutAssetPropertyValueEntry" - }, - "type": "array" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "PutAssetPropertyValueEntries", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.KinesisAction": { - "additionalProperties": false, - "properties": { - "PartitionKey": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StreamName": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "StreamName" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.LambdaAction": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRule.PutAssetPropertyValueEntry": { - "additionalProperties": false, - "properties": { - "AssetId": { - "type": "string" - }, - "EntryId": { - "type": "string" - }, - "PropertyAlias": { - "type": "string" - }, - "PropertyId": { - "type": "string" - }, - "PropertyValues": { - "items": { - "$ref": "#/definitions/AWS::IoT::TopicRule.AssetPropertyValue" - }, - "type": "array" - } - }, - "required": [ - "PropertyValues" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.PutItemInput": { - "additionalProperties": false, - "properties": { - "TableName": { - "type": "string" - } - }, - "required": [ - "TableName" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.RepublishAction": { - "additionalProperties": false, - "properties": { - "Qos": { - "type": "number" - }, - "RoleArn": { - "type": "string" - }, - "Topic": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "Topic" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.S3Action": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "CannedAcl": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "BucketName", - "Key", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.SigV4Authorization": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "ServiceName": { - "type": "string" - }, - "SigningRegion": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "ServiceName", - "SigningRegion" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.SnsAction": { - "additionalProperties": false, - "properties": { - "MessageFormat": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "TargetArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.SqsAction": { - "additionalProperties": false, - "properties": { - "QueueUrl": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UseBase64": { - "type": "boolean" - } - }, - "required": [ - "QueueUrl", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.StepFunctionsAction": { - "additionalProperties": false, - "properties": { - "ExecutionNamePrefix": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StateMachineName": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "StateMachineName" - ], - "type": "object" - }, - "AWS::IoT::TopicRule.TopicRulePayload": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::IoT::TopicRule.Action" - }, - "type": "array" - }, - "AwsIotSqlVersion": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ErrorAction": { - "$ref": "#/definitions/AWS::IoT::TopicRule.Action" - }, - "RuleDisabled": { - "type": "boolean" - }, - "Sql": { - "type": "string" - } - }, - "required": [ - "Actions", - "Sql" - ], - "type": "object" - }, - "AWS::IoT::TopicRuleDestination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HttpUrlProperties": { - "$ref": "#/definitions/AWS::IoT::TopicRuleDestination.HttpUrlDestinationSummary" - }, - "Status": { - "type": "string" - }, - "VpcProperties": { - "$ref": "#/definitions/AWS::IoT::TopicRuleDestination.VpcDestinationProperties" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoT::TopicRuleDestination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoT::TopicRuleDestination.HttpUrlDestinationSummary": { - "additionalProperties": false, - "properties": { - "ConfirmationUrl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoT::TopicRuleDestination.VpcDestinationProperties": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Channel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ChannelName": { - "type": "string" - }, - "ChannelStorage": { - "$ref": "#/definitions/AWS::IoTAnalytics::Channel.ChannelStorage" - }, - "RetentionPeriod": { - "$ref": "#/definitions/AWS::IoTAnalytics::Channel.RetentionPeriod" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTAnalytics::Channel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Channel.ChannelStorage": { - "additionalProperties": false, - "properties": { - "CustomerManagedS3": { - "$ref": "#/definitions/AWS::IoTAnalytics::Channel.CustomerManagedS3" - }, - "ServiceManagedS3": { - "$ref": "#/definitions/AWS::IoTAnalytics::Channel.ServiceManagedS3" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Channel.CustomerManagedS3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "KeyPrefix": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Bucket", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Channel.RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "type": "number" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Channel.ServiceManagedS3": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.Action" - }, - "type": "array" - }, - "ContentDeliveryRules": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule" - }, - "type": "array" - }, - "DatasetName": { - "type": "string" - }, - "LateDataRules": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.LateDataRule" - }, - "type": "array" - }, - "RetentionPeriod": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.RetentionPeriod" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Triggers": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.Trigger" - }, - "type": "array" - }, - "VersioningConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.VersioningConfiguration" - } - }, - "required": [ - "Actions" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTAnalytics::Dataset" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.Action": { - "additionalProperties": false, - "properties": { - "ActionName": { - "type": "string" - }, - "ContainerAction": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.ContainerAction" - }, - "QueryAction": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.QueryAction" - } - }, - "required": [ - "ActionName" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.ContainerAction": { - "additionalProperties": false, - "properties": { - "ExecutionRoleArn": { - "type": "string" - }, - "Image": { - "type": "string" - }, - "ResourceConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.ResourceConfiguration" - }, - "Variables": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.Variable" - }, - "type": "array" - } - }, - "required": [ - "ExecutionRoleArn", - "Image", - "ResourceConfiguration" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRule": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination" - }, - "EntryName": { - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.DatasetContentDeliveryRuleDestination": { - "additionalProperties": false, - "properties": { - "IotEventsDestinationConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration" - }, - "S3DestinationConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.S3DestinationConfiguration" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.DatasetContentVersionValue": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.DeltaTime": { - "additionalProperties": false, - "properties": { - "OffsetSeconds": { - "type": "number" - }, - "TimeExpression": { - "type": "string" - } - }, - "required": [ - "OffsetSeconds", - "TimeExpression" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.DeltaTimeSessionWindowConfiguration": { - "additionalProperties": false, - "properties": { - "TimeoutInMinutes": { - "type": "number" - } - }, - "required": [ - "TimeoutInMinutes" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.Filter": { - "additionalProperties": false, - "properties": { - "DeltaTime": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.DeltaTime" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.GlueConfiguration": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "DatabaseName", - "TableName" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.IotEventsDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "InputName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "InputName", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.LateDataRule": { - "additionalProperties": false, - "properties": { - "RuleConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.LateDataRuleConfiguration" - }, - "RuleName": { - "type": "string" - } - }, - "required": [ - "RuleConfiguration" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.LateDataRuleConfiguration": { - "additionalProperties": false, - "properties": { - "DeltaTimeSessionWindowConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.DeltaTimeSessionWindowConfiguration" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.OutputFileUriValue": { - "additionalProperties": false, - "properties": { - "FileName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.QueryAction": { - "additionalProperties": false, - "properties": { - "Filters": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.Filter" - }, - "type": "array" - }, - "SqlQuery": { - "type": "string" - } - }, - "required": [ - "SqlQuery" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.ResourceConfiguration": { - "additionalProperties": false, - "properties": { - "ComputeType": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "ComputeType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "type": "number" - }, - "Unlimited": { - "type": "boolean" - } - }, - "required": [ - "NumberOfDays", - "Unlimited" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.S3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "GlueConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.GlueConfiguration" - }, - "Key": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.Schedule": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.Trigger": { - "additionalProperties": false, - "properties": { - "Schedule": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.Schedule" - }, - "TriggeringDataset": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.TriggeringDataset" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.TriggeringDataset": { - "additionalProperties": false, - "properties": { - "DatasetName": { - "type": "string" - } - }, - "required": [ - "DatasetName" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.Variable": { - "additionalProperties": false, - "properties": { - "DatasetContentVersionValue": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.DatasetContentVersionValue" - }, - "DoubleValue": { - "type": "number" - }, - "OutputFileUriValue": { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset.OutputFileUriValue" - }, - "StringValue": { - "type": "string" - }, - "VariableName": { - "type": "string" - } - }, - "required": [ - "VariableName" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Dataset.VersioningConfiguration": { - "additionalProperties": false, - "properties": { - "MaxVersions": { - "type": "number" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DatastoreName": { - "type": "string" - }, - "DatastoreStorage": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.DatastoreStorage" - }, - "FileFormatConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.FileFormatConfiguration" - }, - "RetentionPeriod": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.RetentionPeriod" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTAnalytics::Datastore" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.Column": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.CustomerManagedS3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "KeyPrefix": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "Bucket", - "RoleArn" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.DatastoreStorage": { - "additionalProperties": false, - "properties": { - "CustomerManagedS3": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.CustomerManagedS3" - }, - "ServiceManagedS3": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.ServiceManagedS3" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.FileFormatConfiguration": { - "additionalProperties": false, - "properties": { - "JsonConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.JsonConfiguration" - }, - "ParquetConfiguration": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.ParquetConfiguration" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.JsonConfiguration": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.ParquetConfiguration": { - "additionalProperties": false, - "properties": { - "SchemaDefinition": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.SchemaDefinition" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.RetentionPeriod": { - "additionalProperties": false, - "properties": { - "NumberOfDays": { - "type": "number" - }, - "Unlimited": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.SchemaDefinition": { - "additionalProperties": false, - "properties": { - "Columns": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore.Column" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Datastore.ServiceManagedS3": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PipelineActivities": { - "items": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Activity" - }, - "type": "array" - }, - "PipelineName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PipelineActivities" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTAnalytics::Pipeline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Activity": { - "additionalProperties": false, - "properties": { - "AddAttributes": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.AddAttributes" - }, - "Channel": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Channel" - }, - "Datastore": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Datastore" - }, - "DeviceRegistryEnrich": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich" - }, - "DeviceShadowEnrich": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich" - }, - "Filter": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Filter" - }, - "Lambda": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Lambda" - }, - "Math": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.Math" - }, - "RemoveAttributes": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.RemoveAttributes" - }, - "SelectAttributes": { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline.SelectAttributes" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.AddAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Channel": { - "additionalProperties": false, - "properties": { - "ChannelName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Datastore": { - "additionalProperties": false, - "properties": { - "DatastoreName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.DeviceRegistryEnrich": { - "additionalProperties": false, - "properties": { - "Attribute": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "ThingName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.DeviceShadowEnrich": { - "additionalProperties": false, - "properties": { - "Attribute": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "ThingName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Filter": { - "additionalProperties": false, - "properties": { - "Filter": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Lambda": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "type": "number" - }, - "LambdaName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.Math": { - "additionalProperties": false, - "properties": { - "Attribute": { - "type": "string" - }, - "Math": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.RemoveAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTAnalytics::Pipeline.SelectAttributes": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Next": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DetectorModelDefinition": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.DetectorModelDefinition" - }, - "DetectorModelDescription": { - "type": "string" - }, - "DetectorModelName": { - "type": "string" - }, - "EvaluationMethod": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTEvents::DetectorModel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Action": { - "additionalProperties": false, - "properties": { - "ClearTimer": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.ClearTimer" - }, - "DynamoDB": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.DynamoDB" - }, - "DynamoDBv2": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.DynamoDBv2" - }, - "Firehose": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Firehose" - }, - "IotEvents": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.IotEvents" - }, - "IotSiteWise": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.IotSiteWise" - }, - "IotTopicPublish": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.IotTopicPublish" - }, - "Lambda": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Lambda" - }, - "ResetTimer": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.ResetTimer" - }, - "SetTimer": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.SetTimer" - }, - "SetVariable": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.SetVariable" - }, - "Sns": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Sns" - }, - "Sqs": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Sqs" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp": { - "additionalProperties": false, - "properties": { - "OffsetInNanos": { - "type": "string" - }, - "TimeInSeconds": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.AssetPropertyValue": { - "additionalProperties": false, - "properties": { - "Quality": { - "type": "string" - }, - "Timestamp": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp" - }, - "Value": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.AssetPropertyVariant" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.AssetPropertyVariant": { - "additionalProperties": false, - "properties": { - "BooleanValue": { - "type": "string" - }, - "DoubleValue": { - "type": "string" - }, - "IntegerValue": { - "type": "string" - }, - "StringValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.ClearTimer": { - "additionalProperties": false, - "properties": { - "TimerName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.DetectorModelDefinition": { - "additionalProperties": false, - "properties": { - "InitialStateName": { - "type": "string" - }, - "States": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.State" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.DynamoDB": { - "additionalProperties": false, - "properties": { - "HashKeyField": { - "type": "string" - }, - "HashKeyType": { - "type": "string" - }, - "HashKeyValue": { - "type": "string" - }, - "Operation": { - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - }, - "PayloadField": { - "type": "string" - }, - "RangeKeyField": { - "type": "string" - }, - "RangeKeyType": { - "type": "string" - }, - "RangeKeyValue": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.DynamoDBv2": { - "additionalProperties": false, - "properties": { - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - }, - "TableName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Event": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Action" - }, - "type": "array" - }, - "Condition": { - "type": "string" - }, - "EventName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Firehose": { - "additionalProperties": false, - "properties": { - "DeliveryStreamName": { - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - }, - "Separator": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.IotEvents": { - "additionalProperties": false, - "properties": { - "InputName": { - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.IotSiteWise": { - "additionalProperties": false, - "properties": { - "AssetId": { - "type": "string" - }, - "EntryId": { - "type": "string" - }, - "PropertyAlias": { - "type": "string" - }, - "PropertyId": { - "type": "string" - }, - "PropertyValue": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.AssetPropertyValue" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.IotTopicPublish": { - "additionalProperties": false, - "properties": { - "MqttTopic": { - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Lambda": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.OnEnter": { - "additionalProperties": false, - "properties": { - "Events": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Event" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.OnExit": { - "additionalProperties": false, - "properties": { - "Events": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Event" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.OnInput": { - "additionalProperties": false, - "properties": { - "Events": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Event" - }, - "type": "array" - }, - "TransitionEvents": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.TransitionEvent" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Payload": { - "additionalProperties": false, - "properties": { - "ContentExpression": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.ResetTimer": { - "additionalProperties": false, - "properties": { - "TimerName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.SetTimer": { - "additionalProperties": false, - "properties": { - "DurationExpression": { - "type": "string" - }, - "Seconds": { - "type": "number" - }, - "TimerName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.SetVariable": { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - }, - "VariableName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Sns": { - "additionalProperties": false, - "properties": { - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - }, - "TargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.Sqs": { - "additionalProperties": false, - "properties": { - "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Payload" - }, - "QueueUrl": { - "type": "string" - }, - "UseBase64": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.State": { - "additionalProperties": false, - "properties": { - "OnEnter": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.OnEnter" - }, - "OnExit": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.OnExit" - }, - "OnInput": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.OnInput" - }, - "StateName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::DetectorModel.TransitionEvent": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel.Action" - }, - "type": "array" - }, - "Condition": { - "type": "string" - }, - "EventName": { - "type": "string" - }, - "NextState": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::Input": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InputDefinition": { - "$ref": "#/definitions/AWS::IoTEvents::Input.InputDefinition" - }, - "InputDescription": { - "type": "string" - }, - "InputName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTEvents::Input" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTEvents::Input.Attribute": { - "additionalProperties": false, - "properties": { - "JsonPath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTEvents::Input.InputDefinition": { - "additionalProperties": false, - "properties": { - "Attributes": { - "items": { - "$ref": "#/definitions/AWS::IoTEvents::Input.Attribute" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessPolicyIdentity": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity" - }, - "AccessPolicyPermission": { - "type": "string" - }, - "AccessPolicyResource": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.AccessPolicyResource" - } - }, - "required": [ - "AccessPolicyIdentity", - "AccessPolicyPermission", - "AccessPolicyResource" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::AccessPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity": { - "additionalProperties": false, - "properties": { - "IamRole": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.IamRole" - }, - "IamUser": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.IamUser" - }, - "User": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.User" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.AccessPolicyResource": { - "additionalProperties": false, - "properties": { - "Portal": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.Portal" - }, - "Project": { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.Project" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.IamRole": { - "additionalProperties": false, - "properties": { - "arn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.IamUser": { - "additionalProperties": false, - "properties": { - "arn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.Portal": { - "additionalProperties": false, - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.Project": { - "additionalProperties": false, - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AccessPolicy.User": { - "additionalProperties": false, - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::Asset": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssetHierarchies": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::Asset.AssetHierarchy" - }, - "type": "array" - }, - "AssetModelId": { - "type": "string" - }, - "AssetName": { - "type": "string" - }, - "AssetProperties": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::Asset.AssetProperty" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AssetModelId", - "AssetName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::Asset" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Asset.AssetHierarchy": { - "additionalProperties": false, - "properties": { - "ChildAssetId": { - "type": "string" - }, - "LogicalId": { - "type": "string" - } - }, - "required": [ - "ChildAssetId", - "LogicalId" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Asset.AssetProperty": { - "additionalProperties": false, - "properties": { - "Alias": { - "type": "string" - }, - "LogicalId": { - "type": "string" - }, - "NotificationState": { - "type": "string" - } - }, - "required": [ - "LogicalId" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssetModelCompositeModels": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.AssetModelCompositeModel" - }, - "type": "array" - }, - "AssetModelDescription": { - "type": "string" - }, - "AssetModelHierarchies": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.AssetModelHierarchy" - }, - "type": "array" - }, - "AssetModelName": { - "type": "string" - }, - "AssetModelProperties": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.AssetModelProperty" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AssetModelName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::AssetModel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.AssetModelCompositeModel": { - "additionalProperties": false, - "properties": { - "CompositeModelProperties": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.AssetModelProperty" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.AssetModelHierarchy": { - "additionalProperties": false, - "properties": { - "ChildAssetModelId": { - "type": "string" - }, - "LogicalId": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "ChildAssetModelId", - "LogicalId", - "Name" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.AssetModelProperty": { - "additionalProperties": false, - "properties": { - "DataType": { - "type": "string" - }, - "DataTypeSpec": { - "type": "string" - }, - "LogicalId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Type": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.PropertyType" - }, - "Unit": { - "type": "string" - } - }, - "required": [ - "DataType", - "LogicalId", - "Name", - "Type" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.Attribute": { - "additionalProperties": false, - "properties": { - "DefaultValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.ExpressionVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.VariableValue" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.Metric": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Variables": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.ExpressionVariable" - }, - "type": "array" - }, - "Window": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.MetricWindow" - } - }, - "required": [ - "Expression", - "Variables", - "Window" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.MetricWindow": { - "additionalProperties": false, - "properties": { - "Tumbling": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.TumblingWindow" - } - }, - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.PropertyType": { - "additionalProperties": false, - "properties": { - "Attribute": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.Attribute" - }, - "Metric": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.Metric" - }, - "Transform": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.Transform" - }, - "TypeName": { - "type": "string" - } - }, - "required": [ - "TypeName" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.Transform": { - "additionalProperties": false, - "properties": { - "Expression": { - "type": "string" - }, - "Variables": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.ExpressionVariable" - }, - "type": "array" - } - }, - "required": [ - "Expression", - "Variables" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.TumblingWindow": { - "additionalProperties": false, - "properties": { - "Interval": { - "type": "string" - } - }, - "required": [ - "Interval" - ], - "type": "object" - }, - "AWS::IoTSiteWise::AssetModel.VariableValue": { - "additionalProperties": false, - "properties": { - "HierarchyLogicalId": { - "type": "string" - }, - "PropertyLogicalId": { - "type": "string" - } - }, - "required": [ - "PropertyLogicalId" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Dashboard": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DashboardDefinition": { - "type": "string" - }, - "DashboardDescription": { - "type": "string" - }, - "DashboardName": { - "type": "string" - }, - "ProjectId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DashboardDefinition", - "DashboardDescription", - "DashboardName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::Dashboard" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Gateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GatewayCapabilitySummaries": { - "items": { - "$ref": "#/definitions/AWS::IoTSiteWise::Gateway.GatewayCapabilitySummary" - }, - "type": "array" - }, - "GatewayName": { - "type": "string" - }, - "GatewayPlatform": { - "$ref": "#/definitions/AWS::IoTSiteWise::Gateway.GatewayPlatform" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "GatewayName", - "GatewayPlatform" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::Gateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Gateway.GatewayCapabilitySummary": { - "additionalProperties": false, - "properties": { - "CapabilityConfiguration": { - "type": "string" - }, - "CapabilityNamespace": { - "type": "string" - } - }, - "required": [ - "CapabilityNamespace" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Gateway.GatewayPlatform": { - "additionalProperties": false, - "properties": { - "Greengrass": { - "$ref": "#/definitions/AWS::IoTSiteWise::Gateway.Greengrass" - } - }, - "required": [ - "Greengrass" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Gateway.Greengrass": { - "additionalProperties": false, - "properties": { - "GroupArn": { - "type": "string" - } - }, - "required": [ - "GroupArn" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Portal": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PortalAuthMode": { - "type": "string" - }, - "PortalContactEmail": { - "type": "string" - }, - "PortalDescription": { - "type": "string" - }, - "PortalName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PortalContactEmail", - "PortalName", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::Portal" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTSiteWise::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PortalId": { - "type": "string" - }, - "ProjectDescription": { - "type": "string" - }, - "ProjectName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PortalId", - "ProjectName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTSiteWise::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTThingsGraph::FlowTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CompatibleNamespaceVersion": { - "type": "number" - }, - "Definition": { - "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument" - } - }, - "required": [ - "Definition" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTThingsGraph::FlowTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument": { - "additionalProperties": false, - "properties": { - "Language": { - "type": "string" - }, - "Text": { - "type": "string" - } - }, - "required": [ - "Language", - "Text" - ], - "type": "object" - }, - "AWS::IoTWireless::Destination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Expression": { - "type": "string" - }, - "ExpressionType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Expression", - "ExpressionType", - "Name", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTWireless::Destination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTWireless::DeviceProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LoRaWAN": { - "$ref": "#/definitions/AWS::IoTWireless::DeviceProfile.LoRaWANDeviceProfile" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTWireless::DeviceProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTWireless::DeviceProfile.LoRaWANDeviceProfile": { - "additionalProperties": false, - "properties": { - "ClassBTimeout": { - "type": "number" - }, - "ClassCTimeout": { - "type": "number" - }, - "MacVersion": { - "type": "string" - }, - "MaxDutyCycle": { - "type": "number" - }, - "MaxEirp": { - "type": "number" - }, - "PingSlotDr": { - "type": "number" - }, - "PingSlotFreq": { - "type": "number" - }, - "PingSlotPeriod": { - "type": "number" - }, - "RegParamsRevision": { - "type": "string" - }, - "RfRegion": { - "type": "string" - }, - "Supports32BitFCnt": { - "type": "boolean" - }, - "SupportsClassB": { - "type": "boolean" - }, - "SupportsClassC": { - "type": "boolean" - }, - "SupportsJoin": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::IoTWireless::ServiceProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LoRaWAN": { - "$ref": "#/definitions/AWS::IoTWireless::ServiceProfile.LoRaWANServiceProfile" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTWireless::ServiceProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::IoTWireless::ServiceProfile.LoRaWANServiceProfile": { - "additionalProperties": false, - "properties": { - "AddGwMetadata": { - "type": "boolean" - }, - "ChannelMask": { - "type": "string" - }, - "DevStatusReqFreq": { - "type": "number" - }, - "DlBucketSize": { - "type": "number" - }, - "DlRate": { - "type": "number" - }, - "DlRatePolicy": { - "type": "string" - }, - "DrMax": { - "type": "number" - }, - "DrMin": { - "type": "number" - }, - "HrAllowed": { - "type": "boolean" - }, - "MinGwDiversity": { - "type": "number" - }, - "NwkGeoLoc": { - "type": "boolean" - }, - "PrAllowed": { - "type": "boolean" - }, - "RaAllowed": { - "type": "boolean" - }, - "ReportDevStatusBattery": { - "type": "boolean" - }, - "ReportDevStatusMargin": { - "type": "boolean" - }, - "TargetPer": { - "type": "number" - }, - "UlBucketSize": { - "type": "number" - }, - "UlRate": { - "type": "number" - }, - "UlRatePolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DestinationName": { - "type": "string" - }, - "LastUplinkReceivedAt": { - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.LoRaWANDevice" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThingArn": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "DestinationName", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTWireless::WirelessDevice" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.AbpV10x": { - "additionalProperties": false, - "properties": { - "DevAddr": { - "type": "string" - }, - "SessionKeys": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.SessionKeysAbpV10x" - } - }, - "required": [ - "DevAddr", - "SessionKeys" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.AbpV11": { - "additionalProperties": false, - "properties": { - "DevAddr": { - "type": "string" - }, - "SessionKeys": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.SessionKeysAbpV11" - } - }, - "required": [ - "DevAddr", - "SessionKeys" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.LoRaWANDevice": { - "additionalProperties": false, - "properties": { - "AbpV10x": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.AbpV10x" - }, - "AbpV11": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.AbpV11" - }, - "DevEui": { - "type": "string" - }, - "DeviceProfileId": { - "type": "string" - }, - "OtaaV10x": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.OtaaV10x" - }, - "OtaaV11": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice.OtaaV11" - }, - "ServiceProfileId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.OtaaV10x": { - "additionalProperties": false, - "properties": { - "AppEui": { - "type": "string" - }, - "AppKey": { - "type": "string" - } - }, - "required": [ - "AppEui", - "AppKey" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.OtaaV11": { - "additionalProperties": false, - "properties": { - "AppKey": { - "type": "string" - }, - "JoinEui": { - "type": "string" - }, - "NwkKey": { - "type": "string" - } - }, - "required": [ - "AppKey", - "JoinEui", - "NwkKey" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.SessionKeysAbpV10x": { - "additionalProperties": false, - "properties": { - "AppSKey": { - "type": "string" - }, - "NwkSKey": { - "type": "string" - } - }, - "required": [ - "AppSKey", - "NwkSKey" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessDevice.SessionKeysAbpV11": { - "additionalProperties": false, - "properties": { - "AppSKey": { - "type": "string" - }, - "FNwkSIntKey": { - "type": "string" - }, - "NwkSEncKey": { - "type": "string" - }, - "SNwkSIntKey": { - "type": "string" - } - }, - "required": [ - "AppSKey", - "FNwkSIntKey", - "NwkSEncKey", - "SNwkSIntKey" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessGateway": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "LastUplinkReceivedAt": { - "type": "string" - }, - "LoRaWAN": { - "$ref": "#/definitions/AWS::IoTWireless::WirelessGateway.LoRaWANGateway" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThingArn": { - "type": "string" - } - }, - "required": [ - "LoRaWAN" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::IoTWireless::WirelessGateway" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::IoTWireless::WirelessGateway.LoRaWANGateway": { - "additionalProperties": false, - "properties": { - "GatewayEui": { - "type": "string" - }, - "RfRegion": { - "type": "string" - } - }, - "required": [ - "GatewayEui", - "RfRegion" - ], - "type": "object" - }, - "AWS::KMS::Alias": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AliasName": { - "type": "string" - }, - "TargetKeyId": { - "type": "string" - } - }, - "required": [ - "AliasName", - "TargetKeyId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KMS::Alias" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KMS::Key": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "EnableKeyRotation": { - "type": "boolean" - }, - "Enabled": { - "type": "boolean" - }, - "KeyPolicy": { - "type": "object" - }, - "KeySpec": { - "type": "string" - }, - "KeyUsage": { - "type": "string" - }, - "PendingWindowInDays": { - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "KeyPolicy" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KMS::Key" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Kendra::DataSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataSourceConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceConfiguration" - }, - "Description": { - "type": "string" - }, - "IndexId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Schedule": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "IndexId", - "Name", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Kendra::DataSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.AccessControlListConfiguration": { - "additionalProperties": false, - "properties": { - "KeyPath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.AclConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedGroupsColumnName": { - "type": "string" - } - }, - "required": [ - "AllowedGroupsColumnName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ChangeDetectingColumns": { - "additionalProperties": false, - "properties": { - "ChangeDetectingColumns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ColumnConfiguration": { - "additionalProperties": false, - "properties": { - "ChangeDetectingColumns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ChangeDetectingColumns" - }, - "DocumentDataColumnName": { - "type": "string" - }, - "DocumentIdColumnName": { - "type": "string" - }, - "DocumentTitleColumnName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - } - }, - "required": [ - "ChangeDetectingColumns", - "DocumentDataColumnName", - "DocumentIdColumnName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceAttachmentConfiguration": { - "additionalProperties": false, - "properties": { - "AttachmentFieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceAttachmentFieldMappingsList" - }, - "CrawlAttachments": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceAttachmentFieldMappingsList": { - "additionalProperties": false, - "properties": { - "ConfluenceAttachmentFieldMappingsList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceAttachmentToIndexFieldMapping" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceAttachmentToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "type": "string" - }, - "DateFieldFormat": { - "type": "string" - }, - "IndexFieldName": { - "type": "string" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceBlogConfiguration": { - "additionalProperties": false, - "properties": { - "BlogFieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceBlogFieldMappingsList" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceBlogFieldMappingsList": { - "additionalProperties": false, - "properties": { - "ConfluenceBlogFieldMappingsList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceBlogToIndexFieldMapping" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceBlogToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "type": "string" - }, - "DateFieldFormat": { - "type": "string" - }, - "IndexFieldName": { - "type": "string" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceConfiguration": { - "additionalProperties": false, - "properties": { - "AttachmentConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceAttachmentConfiguration" - }, - "BlogConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceBlogConfiguration" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "InclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "PageConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluencePageConfiguration" - }, - "SecretArn": { - "type": "string" - }, - "ServerUrl": { - "type": "string" - }, - "SpaceConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceSpaceConfiguration" - }, - "Version": { - "type": "string" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceVpcConfiguration" - } - }, - "required": [ - "SecretArn", - "ServerUrl", - "Version" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluencePageConfiguration": { - "additionalProperties": false, - "properties": { - "PageFieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluencePageFieldMappingsList" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluencePageFieldMappingsList": { - "additionalProperties": false, - "properties": { - "ConfluencePageFieldMappingsList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluencePageToIndexFieldMapping" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluencePageToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "type": "string" - }, - "DateFieldFormat": { - "type": "string" - }, - "IndexFieldName": { - "type": "string" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceSpaceConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlArchivedSpaces": { - "type": "boolean" - }, - "CrawlPersonalSpaces": { - "type": "boolean" - }, - "ExcludeSpaces": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceSpaceList" - }, - "IncludeSpaces": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceSpaceList" - }, - "SpaceFieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceSpaceFieldMappingsList" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceSpaceFieldMappingsList": { - "additionalProperties": false, - "properties": { - "ConfluenceSpaceFieldMappingsList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceSpaceToIndexFieldMapping" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceSpaceList": { - "additionalProperties": false, - "properties": { - "ConfluenceSpaceList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ConfluenceSpaceToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "type": "string" - }, - "DateFieldFormat": { - "type": "string" - }, - "IndexFieldName": { - "type": "string" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ConnectionConfiguration": { - "additionalProperties": false, - "properties": { - "DatabaseHost": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DatabasePort": { - "type": "number" - }, - "SecretArn": { - "type": "string" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "DatabaseHost", - "DatabaseName", - "DatabasePort", - "SecretArn", - "TableName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.DataSourceConfiguration": { - "additionalProperties": false, - "properties": { - "ConfluenceConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluenceConfiguration" - }, - "DatabaseConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DatabaseConfiguration" - }, - "GoogleDriveConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.GoogleDriveConfiguration" - }, - "OneDriveConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.OneDriveConfiguration" - }, - "S3Configuration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.S3DataSourceConfiguration" - }, - "SalesforceConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceConfiguration" - }, - "ServiceNowConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ServiceNowConfiguration" - }, - "SharePointConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SharePointConfiguration" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings": { - "additionalProperties": false, - "properties": { - "DataSourceInclusionsExclusionsStrings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.DataSourceToIndexFieldMapping": { - "additionalProperties": false, - "properties": { - "DataSourceFieldName": { - "type": "string" - }, - "DateFieldFormat": { - "type": "string" - }, - "IndexFieldName": { - "type": "string" - } - }, - "required": [ - "DataSourceFieldName", - "IndexFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList": { - "additionalProperties": false, - "properties": { - "DataSourceToIndexFieldMappingList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMapping" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.DataSourceVpcConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.DatabaseConfiguration": { - "additionalProperties": false, - "properties": { - "AclConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.AclConfiguration" - }, - "ColumnConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ColumnConfiguration" - }, - "ConnectionConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ConnectionConfiguration" - }, - "DatabaseEngineType": { - "type": "string" - }, - "SqlConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SqlConfiguration" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceVpcConfiguration" - } - }, - "required": [ - "ColumnConfiguration", - "ConnectionConfiguration", - "DatabaseEngineType" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.DocumentsMetadataConfiguration": { - "additionalProperties": false, - "properties": { - "S3Prefix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ExcludeMimeTypesList": { - "additionalProperties": false, - "properties": { - "ExcludeMimeTypesList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ExcludeSharedDrivesList": { - "additionalProperties": false, - "properties": { - "ExcludeSharedDrivesList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ExcludeUserAccountsList": { - "additionalProperties": false, - "properties": { - "ExcludeUserAccountsList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.GoogleDriveConfiguration": { - "additionalProperties": false, - "properties": { - "ExcludeMimeTypes": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ExcludeMimeTypesList" - }, - "ExcludeSharedDrives": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ExcludeSharedDrivesList" - }, - "ExcludeUserAccounts": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ExcludeUserAccountsList" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "SecretArn": { - "type": "string" - } - }, - "required": [ - "SecretArn" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.OneDriveConfiguration": { - "additionalProperties": false, - "properties": { - "DisableLocalGroups": { - "type": "boolean" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "OneDriveUsers": { - "$ref": "#/definitions/AWS::Kendra::DataSource.OneDriveUsers" - }, - "SecretArn": { - "type": "string" - }, - "TenantDomain": { - "type": "string" - } - }, - "required": [ - "OneDriveUsers", - "SecretArn", - "TenantDomain" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.OneDriveUserList": { - "additionalProperties": false, - "properties": { - "OneDriveUserList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.OneDriveUsers": { - "additionalProperties": false, - "properties": { - "OneDriveUserList": { - "$ref": "#/definitions/AWS::Kendra::DataSource.OneDriveUserList" - }, - "OneDriveUserS3Path": { - "$ref": "#/definitions/AWS::Kendra::DataSource.S3Path" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.S3DataSourceConfiguration": { - "additionalProperties": false, - "properties": { - "AccessControlListConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.AccessControlListConfiguration" - }, - "BucketName": { - "type": "string" - }, - "DocumentsMetadataConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DocumentsMetadataConfiguration" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "InclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "InclusionPrefixes": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.S3Path": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceChatterFeedConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "IncludeFilterTypes": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceChatterFeedIncludeFilterTypes" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceChatterFeedIncludeFilterTypes": { - "additionalProperties": false, - "properties": { - "SalesforceChatterFeedIncludeFilterTypes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceConfiguration": { - "additionalProperties": false, - "properties": { - "ChatterFeedConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceChatterFeedConfiguration" - }, - "CrawlAttachments": { - "type": "boolean" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "KnowledgeArticleConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceKnowledgeArticleConfiguration" - }, - "SecretArn": { - "type": "string" - }, - "ServerUrl": { - "type": "string" - }, - "StandardObjectAttachmentConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceStandardObjectAttachmentConfiguration" - }, - "StandardObjectConfigurations": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceStandardObjectConfigurationList" - } - }, - "required": [ - "SecretArn", - "ServerUrl" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceCustomKnowledgeArticleTypeConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DocumentDataFieldName", - "Name" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceCustomKnowledgeArticleTypeConfigurationList": { - "additionalProperties": false, - "properties": { - "SalesforceCustomKnowledgeArticleTypeConfigurationList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceCustomKnowledgeArticleTypeConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceKnowledgeArticleConfiguration": { - "additionalProperties": false, - "properties": { - "CustomKnowledgeArticleTypeConfigurations": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceCustomKnowledgeArticleTypeConfigurationList" - }, - "IncludedStates": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceKnowledgeArticleStateList" - }, - "StandardKnowledgeArticleTypeConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceStandardKnowledgeArticleTypeConfiguration" - } - }, - "required": [ - "IncludedStates" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceKnowledgeArticleStateList": { - "additionalProperties": false, - "properties": { - "SalesforceKnowledgeArticleStateList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceStandardKnowledgeArticleTypeConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceStandardObjectAttachmentConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentTitleFieldName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceStandardObjectConfiguration": { - "additionalProperties": false, - "properties": { - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DocumentDataFieldName", - "Name" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SalesforceStandardObjectConfigurationList": { - "additionalProperties": false, - "properties": { - "SalesforceStandardObjectConfigurationList": { - "items": { - "$ref": "#/definitions/AWS::Kendra::DataSource.SalesforceStandardObjectConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kendra::DataSource.ServiceNowConfiguration": { - "additionalProperties": false, - "properties": { - "HostUrl": { - "type": "string" - }, - "KnowledgeArticleConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ServiceNowKnowledgeArticleConfiguration" - }, - "SecretArn": { - "type": "string" - }, - "ServiceCatalogConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.ServiceNowServiceCatalogConfiguration" - }, - "ServiceNowBuildVersion": { - "type": "string" - } - }, - "required": [ - "HostUrl", - "SecretArn", - "ServiceNowBuildVersion" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ServiceNowKnowledgeArticleConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.ServiceNowServiceCatalogConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DocumentDataFieldName": { - "type": "string" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "ExcludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "IncludeAttachmentFilePatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - } - }, - "required": [ - "DocumentDataFieldName" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SharePointConfiguration": { - "additionalProperties": false, - "properties": { - "CrawlAttachments": { - "type": "boolean" - }, - "DisableLocalGroups": { - "type": "boolean" - }, - "DocumentTitleFieldName": { - "type": "string" - }, - "ExclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "FieldMappings": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMappingList" - }, - "InclusionPatterns": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceInclusionsExclusionsStrings" - }, - "SecretArn": { - "type": "string" - }, - "SharePointVersion": { - "type": "string" - }, - "Urls": { - "items": { - "type": "string" - }, - "type": "array" - }, - "UseChangeLog": { - "type": "boolean" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceVpcConfiguration" - } - }, - "required": [ - "SecretArn", - "SharePointVersion", - "Urls" - ], - "type": "object" - }, - "AWS::Kendra::DataSource.SqlConfiguration": { - "additionalProperties": false, - "properties": { - "QueryIdentifiersEnclosingOption": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Kendra::Faq": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "FileFormat": { - "type": "string" - }, - "IndexId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "S3Path": { - "$ref": "#/definitions/AWS::Kendra::Faq.S3Path" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "IndexId", - "Name", - "RoleArn", - "S3Path" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Kendra::Faq" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Kendra::Faq.S3Path": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::Kendra::Index": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CapacityUnits": { - "$ref": "#/definitions/AWS::Kendra::Index.CapacityUnitsConfiguration" - }, - "Description": { - "type": "string" - }, - "DocumentMetadataConfigurations": { - "items": { - "$ref": "#/definitions/AWS::Kendra::Index.DocumentMetadataConfiguration" - }, - "type": "array" - }, - "Edition": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/AWS::Kendra::Index.ServerSideEncryptionConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserContextPolicy": { - "type": "string" - }, - "UserTokenConfigurations": { - "items": { - "$ref": "#/definitions/AWS::Kendra::Index.UserTokenConfiguration" - }, - "type": "array" - } - }, - "required": [ - "Edition", - "Name", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Kendra::Index" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Kendra::Index.CapacityUnitsConfiguration": { - "additionalProperties": false, - "properties": { - "QueryCapacityUnits": { - "type": "number" - }, - "StorageCapacityUnits": { - "type": "number" - } - }, - "required": [ - "QueryCapacityUnits", - "StorageCapacityUnits" - ], - "type": "object" - }, - "AWS::Kendra::Index.DocumentMetadataConfiguration": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Relevance": { - "$ref": "#/definitions/AWS::Kendra::Index.Relevance" - }, - "Search": { - "$ref": "#/definitions/AWS::Kendra::Index.Search" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AWS::Kendra::Index.JsonTokenTypeConfiguration": { - "additionalProperties": false, - "properties": { - "GroupAttributeField": { - "type": "string" - }, - "UserNameAttributeField": { - "type": "string" - } - }, - "required": [ - "GroupAttributeField", - "UserNameAttributeField" - ], - "type": "object" - }, - "AWS::Kendra::Index.JwtTokenTypeConfiguration": { - "additionalProperties": false, - "properties": { - "ClaimRegex": { - "type": "string" - }, - "GroupAttributeField": { - "type": "string" - }, - "Issuer": { - "type": "string" - }, - "KeyLocation": { - "type": "string" - }, - "SecretManagerArn": { - "type": "string" - }, - "URL": { - "type": "string" - }, - "UserNameAttributeField": { - "type": "string" - } - }, - "required": [ - "KeyLocation" - ], - "type": "object" - }, - "AWS::Kendra::Index.Relevance": { - "additionalProperties": false, - "properties": { - "Duration": { - "type": "string" - }, - "Freshness": { - "type": "boolean" - }, - "Importance": { - "type": "number" - }, - "RankOrder": { - "type": "string" - }, - "ValueImportanceItems": { - "$ref": "#/definitions/AWS::Kendra::Index.ValueImportanceItems" - } - }, - "type": "object" - }, - "AWS::Kendra::Index.Search": { - "additionalProperties": false, - "properties": { - "Displayable": { - "type": "boolean" - }, - "Facetable": { - "type": "boolean" - }, - "Searchable": { - "type": "boolean" - }, - "Sortable": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Kendra::Index.ServerSideEncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Kendra::Index.UserTokenConfiguration": { - "additionalProperties": false, - "properties": { - "JsonTokenTypeConfiguration": { - "$ref": "#/definitions/AWS::Kendra::Index.JsonTokenTypeConfiguration" - }, - "JwtTokenTypeConfiguration": { - "$ref": "#/definitions/AWS::Kendra::Index.JwtTokenTypeConfiguration" - } - }, - "type": "object" - }, - "AWS::Kendra::Index.ValueImportanceItem": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Kendra::Index.ValueImportanceItems": { - "additionalProperties": false, - "properties": { - "ValueImportanceItems": { - "items": { - "$ref": "#/definitions/AWS::Kendra::Index.ValueImportanceItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Kinesis::Stream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RetentionPeriodHours": { - "type": "number" - }, - "ShardCount": { - "type": "number" - }, - "StreamEncryption": { - "$ref": "#/definitions/AWS::Kinesis::Stream.StreamEncryption" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ShardCount" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Kinesis::Stream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Kinesis::Stream.StreamEncryption": { - "additionalProperties": false, - "properties": { - "EncryptionType": { - "type": "string" - }, - "KeyId": { - "type": "string" - } - }, - "required": [ - "EncryptionType", - "KeyId" - ], - "type": "object" - }, - "AWS::Kinesis::StreamConsumer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConsumerName": { - "type": "string" - }, - "StreamARN": { - "type": "string" - } - }, - "required": [ - "ConsumerName", - "StreamARN" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Kinesis::StreamConsumer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationCode": { - "type": "string" - }, - "ApplicationDescription": { - "type": "string" - }, - "ApplicationName": { - "type": "string" - }, - "Inputs": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.Input" - }, - "type": "array" - } - }, - "required": [ - "Inputs" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalytics::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.Input": { - "additionalProperties": false, - "properties": { - "InputParallelism": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.InputParallelism" - }, - "InputProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.InputProcessingConfiguration" - }, - "InputSchema": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.InputSchema" - }, - "KinesisFirehoseInput": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.KinesisFirehoseInput" - }, - "KinesisStreamsInput": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.KinesisStreamsInput" - }, - "NamePrefix": { - "type": "string" - } - }, - "required": [ - "InputSchema", - "NamePrefix" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.InputLambdaProcessor": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.InputParallelism": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisAnalytics::Application.InputProcessingConfiguration": { - "additionalProperties": false, - "properties": { - "InputLambdaProcessor": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.InputLambdaProcessor" - } - }, - "type": "object" - }, - "AWS::KinesisAnalytics::Application.InputSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.RecordColumn" - }, - "type": "array" - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.KinesisFirehoseInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.KinesisStreamsInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.JSONMappingParameters" - } - }, - "type": "object" - }, - "AWS::KinesisAnalytics::Application.RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "Name", - "SqlType" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::Application.RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application.MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "Output": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput.Output" - } - }, - "required": [ - "ApplicationName", - "Output" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalytics::ApplicationOutput" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema": { - "additionalProperties": false, - "properties": { - "RecordFormatType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationOutput.Output": { - "additionalProperties": false, - "properties": { - "DestinationSchema": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput.DestinationSchema" - }, - "KinesisFirehoseOutput": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput.KinesisFirehoseOutput" - }, - "KinesisStreamsOutput": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput.KinesisStreamsOutput" - }, - "LambdaOutput": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput.LambdaOutput" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DestinationSchema" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "ReferenceDataSource": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource" - } - }, - "required": [ - "ApplicationName", - "ReferenceDataSource" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalytics::ApplicationReferenceDataSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.JSONMappingParameters" - } - }, - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "Name", - "SqlType" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "ReferenceSchema": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema" - }, - "S3ReferenceDataSource": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "ReferenceSchema" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.ReferenceSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordColumn" - }, - "type": "array" - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource.RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "AWS::KinesisAnalytics::ApplicationReferenceDataSource.S3ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "FileKey": { - "type": "string" - }, - "ReferenceRoleARN": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "FileKey", - "ReferenceRoleARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration" - }, - "ApplicationDescription": { - "type": "string" - }, - "ApplicationName": { - "type": "string" - }, - "RuntimeEnvironment": { - "type": "string" - }, - "ServiceExecutionRole": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "RuntimeEnvironment", - "ServiceExecutionRole" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalyticsV2::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration": { - "additionalProperties": false, - "properties": { - "CodeContent": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.CodeContent" - }, - "CodeContentType": { - "type": "string" - } - }, - "required": [ - "CodeContent", - "CodeContentType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.ApplicationConfiguration": { - "additionalProperties": false, - "properties": { - "ApplicationCodeConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationCodeConfiguration" - }, - "ApplicationSnapshotConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration" - }, - "EnvironmentProperties": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.EnvironmentProperties" - }, - "FlinkApplicationConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration" - }, - "SqlApplicationConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.ApplicationSnapshotConfiguration": { - "additionalProperties": false, - "properties": { - "SnapshotsEnabled": { - "type": "boolean" - } - }, - "required": [ - "SnapshotsEnabled" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration": { - "additionalProperties": false, - "properties": { - "CheckpointInterval": { - "type": "number" - }, - "CheckpointingEnabled": { - "type": "boolean" - }, - "ConfigurationType": { - "type": "string" - }, - "MinPauseBetweenCheckpoints": { - "type": "number" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.CodeContent": { - "additionalProperties": false, - "properties": { - "S3ContentLocation": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.S3ContentLocation" - }, - "TextContent": { - "type": "string" - }, - "ZipFileContent": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.EnvironmentProperties": { - "additionalProperties": false, - "properties": { - "PropertyGroups": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.PropertyGroup" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.FlinkApplicationConfiguration": { - "additionalProperties": false, - "properties": { - "CheckpointConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.CheckpointConfiguration" - }, - "MonitoringConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration" - }, - "ParallelismConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.Input": { - "additionalProperties": false, - "properties": { - "InputParallelism": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.InputParallelism" - }, - "InputProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration" - }, - "InputSchema": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.InputSchema" - }, - "KinesisFirehoseInput": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput" - }, - "KinesisStreamsInput": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput" - }, - "NamePrefix": { - "type": "string" - } - }, - "required": [ - "InputSchema", - "NamePrefix" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.InputParallelism": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.InputProcessingConfiguration": { - "additionalProperties": false, - "properties": { - "InputLambdaProcessor": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.InputLambdaProcessor" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.InputSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RecordColumn" - }, - "type": "array" - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.KinesisFirehoseInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.KinesisStreamsInput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.JSONMappingParameters" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.MonitoringConfiguration": { - "additionalProperties": false, - "properties": { - "ConfigurationType": { - "type": "string" - }, - "LogLevel": { - "type": "string" - }, - "MetricsLevel": { - "type": "string" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.ParallelismConfiguration": { - "additionalProperties": false, - "properties": { - "AutoScalingEnabled": { - "type": "boolean" - }, - "ConfigurationType": { - "type": "string" - }, - "Parallelism": { - "type": "number" - }, - "ParallelismPerKPU": { - "type": "number" - } - }, - "required": [ - "ConfigurationType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.PropertyGroup": { - "additionalProperties": false, - "properties": { - "PropertyGroupId": { - "type": "string" - }, - "PropertyMap": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "Name", - "SqlType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.S3ContentLocation": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "FileKey": { - "type": "string" - }, - "ObjectVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::Application.SqlApplicationConfiguration": { - "additionalProperties": false, - "properties": { - "Inputs": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.Input" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "CloudWatchLoggingOption": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption" - } - }, - "required": [ - "ApplicationName", - "CloudWatchLoggingOption" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption.CloudWatchLoggingOption": { - "additionalProperties": false, - "properties": { - "LogStreamARN": { - "type": "string" - } - }, - "required": [ - "LogStreamARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "Output": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput.Output" - } - }, - "required": [ - "ApplicationName", - "Output" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalyticsV2::ApplicationOutput" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema": { - "additionalProperties": false, - "properties": { - "RecordFormatType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput": { - "additionalProperties": false, - "properties": { - "ResourceARN": { - "type": "string" - } - }, - "required": [ - "ResourceARN" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationOutput.Output": { - "additionalProperties": false, - "properties": { - "DestinationSchema": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput.DestinationSchema" - }, - "KinesisFirehoseOutput": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisFirehoseOutput" - }, - "KinesisStreamsOutput": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput.KinesisStreamsOutput" - }, - "LambdaOutput": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput.LambdaOutput" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "DestinationSchema" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationName": { - "type": "string" - }, - "ReferenceDataSource": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource" - } - }, - "required": [ - "ApplicationName", - "ReferenceDataSource" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordColumnDelimiter": { - "type": "string" - }, - "RecordRowDelimiter": { - "type": "string" - } - }, - "required": [ - "RecordColumnDelimiter", - "RecordRowDelimiter" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters": { - "additionalProperties": false, - "properties": { - "RecordRowPath": { - "type": "string" - } - }, - "required": [ - "RecordRowPath" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters": { - "additionalProperties": false, - "properties": { - "CSVMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.CSVMappingParameters" - }, - "JSONMappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.JSONMappingParameters" - } - }, - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn": { - "additionalProperties": false, - "properties": { - "Mapping": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SqlType": { - "type": "string" - } - }, - "required": [ - "Name", - "SqlType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat": { - "additionalProperties": false, - "properties": { - "MappingParameters": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.MappingParameters" - }, - "RecordFormatType": { - "type": "string" - } - }, - "required": [ - "RecordFormatType" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "ReferenceSchema": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema" - }, - "S3ReferenceDataSource": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource" - }, - "TableName": { - "type": "string" - } - }, - "required": [ - "ReferenceSchema" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.ReferenceSchema": { - "additionalProperties": false, - "properties": { - "RecordColumns": { - "items": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordColumn" - }, - "type": "array" - }, - "RecordEncoding": { - "type": "string" - }, - "RecordFormat": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.RecordFormat" - } - }, - "required": [ - "RecordColumns", - "RecordFormat" - ], - "type": "object" - }, - "AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.S3ReferenceDataSource": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "FileKey": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "FileKey" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeliveryStreamEncryptionConfigurationInput": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput" - }, - "DeliveryStreamName": { - "type": "string" - }, - "DeliveryStreamType": { - "type": "string" - }, - "ElasticsearchDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration" - }, - "ExtendedS3DestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration" - }, - "HttpEndpointDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration" - }, - "KinesisStreamSourceConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration" - }, - "RedshiftDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration" - }, - "S3DestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - }, - "SplunkDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::KinesisFirehose::DeliveryStream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.BufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "number" - }, - "SizeInMBs": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LogGroupName": { - "type": "string" - }, - "LogStreamName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.CopyCommand": { - "additionalProperties": false, - "properties": { - "CopyOptions": { - "type": "string" - }, - "DataTableColumns": { - "type": "string" - }, - "DataTableName": { - "type": "string" - } - }, - "required": [ - "DataTableName" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "InputFormatConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration" - }, - "OutputFormatConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration" - }, - "SchemaConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.DeliveryStreamEncryptionConfigurationInput": { - "additionalProperties": false, - "properties": { - "KeyARN": { - "type": "string" - }, - "KeyType": { - "type": "string" - } - }, - "required": [ - "KeyType" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.Deserializer": { - "additionalProperties": false, - "properties": { - "HiveJsonSerDe": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe" - }, - "OpenXJsonSerDe": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints": { - "additionalProperties": false, - "properties": { - "IntervalInSeconds": { - "type": "number" - }, - "SizeInMBs": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ElasticsearchDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ElasticsearchBufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "ClusterEndpoint": { - "type": "string" - }, - "DomainARN": { - "type": "string" - }, - "IndexName": { - "type": "string" - }, - "IndexRotationPeriod": { - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions" - }, - "RoleARN": { - "type": "string" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - }, - "TypeName": { - "type": "string" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.VpcConfiguration" - } - }, - "required": [ - "IndexName", - "RoleARN", - "S3Configuration" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ElasticsearchRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "KMSEncryptionConfig": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig" - }, - "NoEncryptionConfig": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ExtendedS3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "CompressionFormat": { - "type": "string" - }, - "DataFormatConversionConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.DataFormatConversionConfiguration" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration" - }, - "ErrorOutputPrefix": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" - }, - "RoleARN": { - "type": "string" - }, - "S3BackupConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - }, - "S3BackupMode": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.HiveJsonSerDe": { - "additionalProperties": false, - "properties": { - "TimestampFormats": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute": { - "additionalProperties": false, - "properties": { - "AttributeName": { - "type": "string" - }, - "AttributeValue": { - "type": "string" - } - }, - "required": [ - "AttributeName", - "AttributeValue" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration": { - "additionalProperties": false, - "properties": { - "AccessKey": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Url" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.HttpEndpointDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "EndpointConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.HttpEndpointConfiguration" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" - }, - "RequestConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.RetryOptions" - }, - "RoleARN": { - "type": "string" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - } - }, - "required": [ - "EndpointConfiguration", - "S3Configuration" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.HttpEndpointRequestConfiguration": { - "additionalProperties": false, - "properties": { - "CommonAttributes": { - "items": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.HttpEndpointCommonAttribute" - }, - "type": "array" - }, - "ContentEncoding": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.InputFormatConfiguration": { - "additionalProperties": false, - "properties": { - "Deserializer": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.Deserializer" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.KMSEncryptionConfig": { - "additionalProperties": false, - "properties": { - "AWSKMSKeyARN": { - "type": "string" - } - }, - "required": [ - "AWSKMSKeyARN" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.KinesisStreamSourceConfiguration": { - "additionalProperties": false, - "properties": { - "KinesisStreamARN": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "KinesisStreamARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.OpenXJsonSerDe": { - "additionalProperties": false, - "properties": { - "CaseInsensitive": { - "type": "boolean" - }, - "ColumnToJsonKeyMappings": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ConvertDotsInJsonKeysToUnderscores": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.OrcSerDe": { - "additionalProperties": false, - "properties": { - "BlockSizeBytes": { - "type": "number" - }, - "BloomFilterColumns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BloomFilterFalsePositiveProbability": { - "type": "number" - }, - "Compression": { - "type": "string" - }, - "DictionaryKeyThreshold": { - "type": "number" - }, - "EnablePadding": { - "type": "boolean" - }, - "FormatVersion": { - "type": "string" - }, - "PaddingTolerance": { - "type": "number" - }, - "RowIndexStride": { - "type": "number" - }, - "StripeSizeBytes": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.OutputFormatConfiguration": { - "additionalProperties": false, - "properties": { - "Serializer": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.Serializer" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ParquetSerDe": { - "additionalProperties": false, - "properties": { - "BlockSizeBytes": { - "type": "number" - }, - "Compression": { - "type": "string" - }, - "EnableDictionaryCompression": { - "type": "boolean" - }, - "MaxPaddingBytes": { - "type": "number" - }, - "PageSizeBytes": { - "type": "number" - }, - "WriterVersion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "Processors": { - "items": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.Processor" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.Processor": { - "additionalProperties": false, - "properties": { - "Parameters": { - "items": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessorParameter" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.ProcessorParameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.RedshiftDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "ClusterJDBCURL": { - "type": "string" - }, - "CopyCommand": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CopyCommand" - }, - "Password": { - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions" - }, - "RoleARN": { - "type": "string" - }, - "S3BackupConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - }, - "Username": { - "type": "string" - } - }, - "required": [ - "ClusterJDBCURL", - "CopyCommand", - "Password", - "RoleARN", - "S3Configuration", - "Username" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.RedshiftRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.RetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration": { - "additionalProperties": false, - "properties": { - "BucketARN": { - "type": "string" - }, - "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.BufferingHints" - }, - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "CompressionFormat": { - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.EncryptionConfiguration" - }, - "ErrorOutputPrefix": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "RoleARN": { - "type": "string" - } - }, - "required": [ - "BucketARN", - "RoleARN" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.SchemaConfiguration": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "RoleARN": { - "type": "string" - }, - "TableName": { - "type": "string" - }, - "VersionId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.Serializer": { - "additionalProperties": false, - "properties": { - "OrcSerDe": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.OrcSerDe" - }, - "ParquetSerDe": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ParquetSerDe" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.SplunkDestinationConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" - }, - "HECAcknowledgmentTimeoutInSeconds": { - "type": "number" - }, - "HECEndpoint": { - "type": "string" - }, - "HECEndpointType": { - "type": "string" - }, - "HECToken": { - "type": "string" - }, - "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" - }, - "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions" - }, - "S3BackupMode": { - "type": "string" - }, - "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" - } - }, - "required": [ - "HECEndpoint", - "HECEndpointType", - "HECToken", - "S3Configuration" - ], - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.SplunkRetryOptions": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::KinesisFirehose::DeliveryStream.VpcConfiguration": { - "additionalProperties": false, - "properties": { - "RoleARN": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "RoleARN", - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "AWS::LakeFormation::DataLakeSettings": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Admins": { - "$ref": "#/definitions/AWS::LakeFormation::DataLakeSettings.Admins" - }, - "TrustedResourceOwners": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LakeFormation::DataLakeSettings" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::LakeFormation::DataLakeSettings.Admins": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::LakeFormation::DataLakeSettings.DataLakePrincipal": { - "additionalProperties": false, - "properties": { - "DataLakePrincipalIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataLakePrincipal": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.DataLakePrincipal" - }, - "Permissions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PermissionsWithGrantOption": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Resource": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.Resource" - } - }, - "required": [ - "DataLakePrincipal", - "Resource" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LakeFormation::Permissions" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::LakeFormation::Permissions.ColumnWildcard": { - "additionalProperties": false, - "properties": { - "ExcludedColumnNames": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.DataLakePrincipal": { - "additionalProperties": false, - "properties": { - "DataLakePrincipalIdentifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.DataLocationResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "S3Resource": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.DatabaseResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.Resource": { - "additionalProperties": false, - "properties": { - "DataLocationResource": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.DataLocationResource" - }, - "DatabaseResource": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.DatabaseResource" - }, - "TableResource": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.TableResource" - }, - "TableWithColumnsResource": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.TableWithColumnsResource" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.TableResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "TableWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.TableWildcard" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Permissions.TableWildcard": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::LakeFormation::Permissions.TableWithColumnsResource": { - "additionalProperties": false, - "properties": { - "CatalogId": { - "type": "string" - }, - "ColumnNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ColumnWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::Permissions.ColumnWildcard" - }, - "DatabaseName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LakeFormation::Resource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceArn": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "UseServiceLinkedRole": { - "type": "boolean" - } - }, - "required": [ - "ResourceArn", - "UseServiceLinkedRole" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LakeFormation::Resource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Alias": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "FunctionVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ProvisionedConcurrencyConfig": { - "$ref": "#/definitions/AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration" - }, - "RoutingConfig": { - "$ref": "#/definitions/AWS::Lambda::Alias.AliasRoutingConfiguration" - } - }, - "required": [ - "FunctionName", - "FunctionVersion", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::Alias" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Alias.AliasRoutingConfiguration": { - "additionalProperties": false, - "properties": { - "AdditionalVersionWeights": { - "items": { - "$ref": "#/definitions/AWS::Lambda::Alias.VersionWeight" - }, - "type": "array" - } - }, - "required": [ - "AdditionalVersionWeights" - ], - "type": "object" - }, - "AWS::Lambda::Alias.ProvisionedConcurrencyConfiguration": { - "additionalProperties": false, - "properties": { - "ProvisionedConcurrentExecutions": { - "type": "number" - } - }, - "required": [ - "ProvisionedConcurrentExecutions" - ], - "type": "object" - }, - "AWS::Lambda::Alias.VersionWeight": { - "additionalProperties": false, - "properties": { - "FunctionVersion": { - "type": "string" - }, - "FunctionWeight": { - "type": "number" - } - }, - "required": [ - "FunctionVersion", - "FunctionWeight" - ], - "type": "object" - }, - "AWS::Lambda::CodeSigningConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowedPublishers": { - "$ref": "#/definitions/AWS::Lambda::CodeSigningConfig.AllowedPublishers" - }, - "CodeSigningPolicies": { - "$ref": "#/definitions/AWS::Lambda::CodeSigningConfig.CodeSigningPolicies" - }, - "Description": { - "type": "string" - } - }, - "required": [ - "AllowedPublishers" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::CodeSigningConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::CodeSigningConfig.AllowedPublishers": { - "additionalProperties": false, - "properties": { - "SigningProfileVersionArns": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SigningProfileVersionArns" - ], - "type": "object" - }, - "AWS::Lambda::CodeSigningConfig.CodeSigningPolicies": { - "additionalProperties": false, - "properties": { - "UntrustedArtifactOnDeployment": { - "type": "string" - } - }, - "required": [ - "UntrustedArtifactOnDeployment" - ], - "type": "object" - }, - "AWS::Lambda::EventInvokeConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationConfig": { - "$ref": "#/definitions/AWS::Lambda::EventInvokeConfig.DestinationConfig" - }, - "FunctionName": { - "type": "string" - }, - "MaximumEventAgeInSeconds": { - "type": "number" - }, - "MaximumRetryAttempts": { - "type": "number" - }, - "Qualifier": { - "type": "string" - } - }, - "required": [ - "FunctionName", - "Qualifier" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::EventInvokeConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::EventInvokeConfig.DestinationConfig": { - "additionalProperties": false, - "properties": { - "OnFailure": { - "$ref": "#/definitions/AWS::Lambda::EventInvokeConfig.OnFailure" - }, - "OnSuccess": { - "$ref": "#/definitions/AWS::Lambda::EventInvokeConfig.OnSuccess" - } - }, - "type": "object" - }, - "AWS::Lambda::EventInvokeConfig.OnFailure": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "AWS::Lambda::EventInvokeConfig.OnSuccess": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - } - }, - "required": [ - "Destination" - ], - "type": "object" - }, - "AWS::Lambda::EventSourceMapping": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BatchSize": { - "type": "number" - }, - "BisectBatchOnFunctionError": { - "type": "boolean" - }, - "DestinationConfig": { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping.DestinationConfig" - }, - "Enabled": { - "type": "boolean" - }, - "EventSourceArn": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "FunctionResponseTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaximumBatchingWindowInSeconds": { - "type": "number" - }, - "MaximumRecordAgeInSeconds": { - "type": "number" - }, - "MaximumRetryAttempts": { - "type": "number" - }, - "ParallelizationFactor": { - "type": "number" - }, - "PartialBatchResponse": { - "type": "boolean" - }, - "Queues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SelfManagedEventSource": { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping.SelfManagedEventSource" - }, - "SourceAccessConfigurations": { - "items": { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping.SourceAccessConfiguration" - }, - "type": "array" - }, - "StartingPosition": { - "type": "string" - }, - "Topics": { - "items": { - "type": "string" - }, - "type": "array" - }, - "TumblingWindowInSeconds": { - "type": "number" - } - }, - "required": [ - "FunctionName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::EventSourceMapping" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::EventSourceMapping.DestinationConfig": { - "additionalProperties": false, - "properties": { - "OnFailure": { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping.OnFailure" - } - }, - "type": "object" - }, - "AWS::Lambda::EventSourceMapping.Endpoints": { - "additionalProperties": false, - "properties": { - "KafkaBootstrapServers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Lambda::EventSourceMapping.OnFailure": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::EventSourceMapping.SelfManagedEventSource": { - "additionalProperties": false, - "properties": { - "Endpoints": { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping.Endpoints" - } - }, - "type": "object" - }, - "AWS::Lambda::EventSourceMapping.SourceAccessConfiguration": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "URI": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::Function": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Code": { - "$ref": "#/definitions/AWS::Lambda::Function.Code" - }, - "CodeSigningConfigArn": { - "type": "string" - }, - "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Lambda::Function.DeadLetterConfig" - }, - "Description": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::Lambda::Function.Environment" - }, - "FileSystemConfigs": { - "items": { - "$ref": "#/definitions/AWS::Lambda::Function.FileSystemConfig" - }, - "type": "array" - }, - "FunctionName": { - "type": "string" - }, - "Handler": { - "type": "string" - }, - "ImageConfig": { - "$ref": "#/definitions/AWS::Lambda::Function.ImageConfig" - }, - "KmsKeyArn": { - "type": "string" - }, - "Layers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MemorySize": { - "type": "number" - }, - "PackageType": { - "type": "string" - }, - "ReservedConcurrentExecutions": { - "type": "number" - }, - "Role": { - "type": "string" - }, - "Runtime": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Timeout": { - "type": "number" - }, - "TracingConfig": { - "$ref": "#/definitions/AWS::Lambda::Function.TracingConfig" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::Lambda::Function.VpcConfig" - } - }, - "required": [ - "Code", - "Role" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::Function" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Function.Code": { - "additionalProperties": false, - "properties": { - "ImageUri": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - }, - "ZipFile": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::Function.DeadLetterConfig": { - "additionalProperties": false, - "properties": { - "TargetArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::Function.Environment": { - "additionalProperties": false, - "properties": { - "Variables": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::Lambda::Function.FileSystemConfig": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "LocalMountPath": { - "type": "string" - } - }, - "required": [ - "Arn", - "LocalMountPath" - ], - "type": "object" - }, - "AWS::Lambda::Function.ImageConfig": { - "additionalProperties": false, - "properties": { - "Command": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EntryPoint": { - "items": { - "type": "string" - }, - "type": "array" - }, - "WorkingDirectory": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::Function.TracingConfig": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Lambda::Function.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "AWS::Lambda::LayerVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CompatibleRuntimes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Content": { - "$ref": "#/definitions/AWS::Lambda::LayerVersion.Content" - }, - "Description": { - "type": "string" - }, - "LayerName": { - "type": "string" - }, - "LicenseInfo": { - "type": "string" - } - }, - "required": [ - "Content" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::LayerVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::LayerVersion.Content": { - "additionalProperties": false, - "properties": { - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "AWS::Lambda::LayerVersionPermission": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "LayerVersionArn": { - "type": "string" - }, - "OrganizationId": { - "type": "string" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "Action", - "LayerVersionArn", - "Principal" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::LayerVersionPermission" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Permission": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "EventSourceToken": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "SourceAccount": { - "type": "string" - }, - "SourceArn": { - "type": "string" - } - }, - "required": [ - "Action", - "FunctionName", - "Principal" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::Permission" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Version": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CodeSha256": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FunctionName": { - "type": "string" - }, - "ProvisionedConcurrencyConfig": { - "$ref": "#/definitions/AWS::Lambda::Version.ProvisionedConcurrencyConfiguration" - } - }, - "required": [ - "FunctionName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Lambda::Version" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Lambda::Version.ProvisionedConcurrencyConfiguration": { - "additionalProperties": false, - "properties": { - "ProvisionedConcurrentExecutions": { - "type": "number" - } - }, - "required": [ - "ProvisionedConcurrentExecutions" - ], - "type": "object" - }, - "AWS::LicenseManager::Grant": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowedOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "GrantName": { - "type": "string" - }, - "HomeRegion": { - "type": "string" - }, - "LicenseArn": { - "type": "string" - }, - "Principals": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LicenseManager::Grant" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::LicenseManager::License": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Beneficiary": { - "type": "string" - }, - "ConsumptionConfiguration": { - "$ref": "#/definitions/AWS::LicenseManager::License.ConsumptionConfiguration" - }, - "Entitlements": { - "items": { - "$ref": "#/definitions/AWS::LicenseManager::License.Entitlement" - }, - "type": "array" - }, - "HomeRegion": { - "type": "string" - }, - "Issuer": { - "$ref": "#/definitions/AWS::LicenseManager::License.IssuerData" - }, - "LicenseMetadata": { - "items": { - "$ref": "#/definitions/AWS::LicenseManager::License.Metadata" - }, - "type": "array" - }, - "LicenseName": { - "type": "string" - }, - "ProductName": { - "type": "string" - }, - "ProductSKU": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Validity": { - "$ref": "#/definitions/AWS::LicenseManager::License.ValidityDateFormat" - } - }, - "required": [ - "ConsumptionConfiguration", - "Entitlements", - "HomeRegion", - "Issuer", - "LicenseName", - "ProductName", - "Validity" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LicenseManager::License" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::LicenseManager::License.BorrowConfiguration": { - "additionalProperties": false, - "properties": { - "AllowEarlyCheckIn": { - "type": "boolean" - }, - "MaxTimeToLiveInMinutes": { - "type": "number" - } - }, - "required": [ - "AllowEarlyCheckIn", - "MaxTimeToLiveInMinutes" - ], - "type": "object" - }, - "AWS::LicenseManager::License.ConsumptionConfiguration": { - "additionalProperties": false, - "properties": { - "BorrowConfiguration": { - "$ref": "#/definitions/AWS::LicenseManager::License.BorrowConfiguration" - }, - "ProvisionalConfiguration": { - "$ref": "#/definitions/AWS::LicenseManager::License.ProvisionalConfiguration" - }, - "RenewType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::LicenseManager::License.Entitlement": { - "additionalProperties": false, - "properties": { - "AllowCheckIn": { - "type": "boolean" - }, - "MaxCount": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Overage": { - "type": "boolean" - }, - "Unit": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Unit" - ], - "type": "object" - }, - "AWS::LicenseManager::License.IssuerData": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SignKey": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::LicenseManager::License.Metadata": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::LicenseManager::License.ProvisionalConfiguration": { - "additionalProperties": false, - "properties": { - "MaxTimeToLiveInMinutes": { - "type": "number" - } - }, - "required": [ - "MaxTimeToLiveInMinutes" - ], - "type": "object" - }, - "AWS::LicenseManager::License.ValidityDateFormat": { - "additionalProperties": false, - "properties": { - "Begin": { - "type": "string" - }, - "End": { - "type": "string" - } - }, - "required": [ - "Begin", - "End" - ], - "type": "object" - }, - "AWS::Logs::Destination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationName": { - "type": "string" - }, - "DestinationPolicy": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "TargetArn": { - "type": "string" - } - }, - "required": [ - "DestinationName", - "DestinationPolicy", - "RoleArn", - "TargetArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Logs::Destination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Logs::LogGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "RetentionInDays": { - "type": "number" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Logs::LogGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Logs::LogStream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "LogGroupName": { - "type": "string" - }, - "LogStreamName": { - "type": "string" - } - }, - "required": [ - "LogGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Logs::LogStream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Logs::MetricFilter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FilterPattern": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "MetricTransformations": { - "items": { - "$ref": "#/definitions/AWS::Logs::MetricFilter.MetricTransformation" - }, - "type": "array" - } - }, - "required": [ - "FilterPattern", - "LogGroupName", - "MetricTransformations" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Logs::MetricFilter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Logs::MetricFilter.MetricTransformation": { - "additionalProperties": false, - "properties": { - "DefaultValue": { - "type": "number" - }, - "MetricName": { - "type": "string" - }, - "MetricNamespace": { - "type": "string" - }, - "MetricValue": { - "type": "string" - } - }, - "required": [ - "MetricName", - "MetricNamespace", - "MetricValue" - ], - "type": "object" - }, - "AWS::Logs::SubscriptionFilter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "FilterPattern": { - "type": "string" - }, - "LogGroupName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "DestinationArn", - "FilterPattern", - "LogGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Logs::SubscriptionFilter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::LookoutVision::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ProjectName": { - "type": "string" - } - }, - "required": [ - "ProjectName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::LookoutVision::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MSK::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BrokerNodeGroupInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.BrokerNodeGroupInfo" - }, - "ClientAuthentication": { - "$ref": "#/definitions/AWS::MSK::Cluster.ClientAuthentication" - }, - "ClusterName": { - "type": "string" - }, - "ConfigurationInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.ConfigurationInfo" - }, - "EncryptionInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.EncryptionInfo" - }, - "EnhancedMonitoring": { - "type": "string" - }, - "KafkaVersion": { - "type": "string" - }, - "LoggingInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.LoggingInfo" - }, - "NumberOfBrokerNodes": { - "type": "number" - }, - "OpenMonitoring": { - "$ref": "#/definitions/AWS::MSK::Cluster.OpenMonitoring" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "BrokerNodeGroupInfo", - "ClusterName", - "KafkaVersion", - "NumberOfBrokerNodes" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MSK::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MSK::Cluster.BrokerLogs": { - "additionalProperties": false, - "properties": { - "CloudWatchLogs": { - "$ref": "#/definitions/AWS::MSK::Cluster.CloudWatchLogs" - }, - "Firehose": { - "$ref": "#/definitions/AWS::MSK::Cluster.Firehose" - }, - "S3": { - "$ref": "#/definitions/AWS::MSK::Cluster.S3" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.BrokerNodeGroupInfo": { - "additionalProperties": false, - "properties": { - "BrokerAZDistribution": { - "type": "string" - }, - "ClientSubnets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "InstanceType": { - "type": "string" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StorageInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.StorageInfo" - } - }, - "required": [ - "ClientSubnets", - "InstanceType" - ], - "type": "object" - }, - "AWS::MSK::Cluster.ClientAuthentication": { - "additionalProperties": false, - "properties": { - "Sasl": { - "$ref": "#/definitions/AWS::MSK::Cluster.Sasl" - }, - "Tls": { - "$ref": "#/definitions/AWS::MSK::Cluster.Tls" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.CloudWatchLogs": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "LogGroup": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::MSK::Cluster.ConfigurationInfo": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "Revision": { - "type": "number" - } - }, - "required": [ - "Arn", - "Revision" - ], - "type": "object" - }, - "AWS::MSK::Cluster.EBSStorageInfo": { - "additionalProperties": false, - "properties": { - "VolumeSize": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.EncryptionAtRest": { - "additionalProperties": false, - "properties": { - "DataVolumeKMSKeyId": { - "type": "string" - } - }, - "required": [ - "DataVolumeKMSKeyId" - ], - "type": "object" - }, - "AWS::MSK::Cluster.EncryptionInTransit": { - "additionalProperties": false, - "properties": { - "ClientBroker": { - "type": "string" - }, - "InCluster": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.EncryptionInfo": { - "additionalProperties": false, - "properties": { - "EncryptionAtRest": { - "$ref": "#/definitions/AWS::MSK::Cluster.EncryptionAtRest" - }, - "EncryptionInTransit": { - "$ref": "#/definitions/AWS::MSK::Cluster.EncryptionInTransit" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.Firehose": { - "additionalProperties": false, - "properties": { - "DeliveryStream": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::MSK::Cluster.JmxExporter": { - "additionalProperties": false, - "properties": { - "EnabledInBroker": { - "type": "boolean" - } - }, - "required": [ - "EnabledInBroker" - ], - "type": "object" - }, - "AWS::MSK::Cluster.LoggingInfo": { - "additionalProperties": false, - "properties": { - "BrokerLogs": { - "$ref": "#/definitions/AWS::MSK::Cluster.BrokerLogs" - } - }, - "required": [ - "BrokerLogs" - ], - "type": "object" - }, - "AWS::MSK::Cluster.NodeExporter": { - "additionalProperties": false, - "properties": { - "EnabledInBroker": { - "type": "boolean" - } - }, - "required": [ - "EnabledInBroker" - ], - "type": "object" - }, - "AWS::MSK::Cluster.OpenMonitoring": { - "additionalProperties": false, - "properties": { - "Prometheus": { - "$ref": "#/definitions/AWS::MSK::Cluster.Prometheus" - } - }, - "required": [ - "Prometheus" - ], - "type": "object" - }, - "AWS::MSK::Cluster.Prometheus": { - "additionalProperties": false, - "properties": { - "JmxExporter": { - "$ref": "#/definitions/AWS::MSK::Cluster.JmxExporter" - }, - "NodeExporter": { - "$ref": "#/definitions/AWS::MSK::Cluster.NodeExporter" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.S3": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::MSK::Cluster.Sasl": { - "additionalProperties": false, - "properties": { - "Scram": { - "$ref": "#/definitions/AWS::MSK::Cluster.Scram" - } - }, - "required": [ - "Scram" - ], - "type": "object" - }, - "AWS::MSK::Cluster.Scram": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "Enabled" - ], - "type": "object" - }, - "AWS::MSK::Cluster.StorageInfo": { - "additionalProperties": false, - "properties": { - "EBSStorageInfo": { - "$ref": "#/definitions/AWS::MSK::Cluster.EBSStorageInfo" - } - }, - "type": "object" - }, - "AWS::MSK::Cluster.Tls": { - "additionalProperties": false, - "properties": { - "CertificateAuthorityArnList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MWAA::Environment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AirflowConfigurationOptions": { - "$ref": "#/definitions/AWS::MWAA::Environment.AirflowConfigurationOptions" - }, - "AirflowVersion": { - "type": "string" - }, - "DagS3Path": { - "type": "string" - }, - "EnvironmentClass": { - "type": "string" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "KmsKey": { - "type": "string" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/AWS::MWAA::Environment.LoggingConfiguration" - }, - "MaxWorkers": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::MWAA::Environment.NetworkConfiguration" - }, - "PluginsS3ObjectVersion": { - "type": "string" - }, - "PluginsS3Path": { - "type": "string" - }, - "RequirementsS3ObjectVersion": { - "type": "string" - }, - "RequirementsS3Path": { - "type": "string" - }, - "SourceBucketArn": { - "type": "string" - }, - "Tags": { - "$ref": "#/definitions/AWS::MWAA::Environment.TagMap" - }, - "WebserverAccessMode": { - "type": "string" - }, - "WeeklyMaintenanceWindowStart": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MWAA::Environment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MWAA::Environment.AirflowConfigurationOptions": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MWAA::Environment.LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "DagProcessingLogs": { - "$ref": "#/definitions/AWS::MWAA::Environment.ModuleLoggingConfiguration" - }, - "SchedulerLogs": { - "$ref": "#/definitions/AWS::MWAA::Environment.ModuleLoggingConfiguration" - }, - "TaskLogs": { - "$ref": "#/definitions/AWS::MWAA::Environment.ModuleLoggingConfiguration" - }, - "WebserverLogs": { - "$ref": "#/definitions/AWS::MWAA::Environment.ModuleLoggingConfiguration" - }, - "WorkerLogs": { - "$ref": "#/definitions/AWS::MWAA::Environment.ModuleLoggingConfiguration" - } - }, - "type": "object" - }, - "AWS::MWAA::Environment.ModuleLoggingConfiguration": { - "additionalProperties": false, - "properties": { - "CloudWatchLogGroupArn": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "LogLevel": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MWAA::Environment.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MWAA::Environment.TagMap": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::Macie::CustomDataIdentifier": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "IgnoreWords": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Keywords": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaximumMatchDistance": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Regex": { - "type": "string" - } - }, - "required": [ - "Name", - "Regex" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Macie::CustomDataIdentifier" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Macie::FindingsFilter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "FindingCriteria": { - "$ref": "#/definitions/AWS::Macie::FindingsFilter.FindingCriteria" - }, - "Name": { - "type": "string" - }, - "Position": { - "type": "number" - } - }, - "required": [ - "FindingCriteria", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Macie::FindingsFilter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Macie::FindingsFilter.Criterion": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::Macie::FindingsFilter.FindingCriteria": { - "additionalProperties": false, - "properties": { - "Criterion": { - "$ref": "#/definitions/AWS::Macie::FindingsFilter.Criterion" - } - }, - "type": "object" - }, - "AWS::Macie::FindingsFilter.FindingsFilterListItem": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Macie::Session": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FindingPublishingFrequency": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Macie::Session" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InvitationId": { - "type": "string" - }, - "MemberConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.MemberConfiguration" - }, - "NetworkConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.NetworkConfiguration" - }, - "NetworkId": { - "type": "string" - } - }, - "required": [ - "MemberConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ManagedBlockchain::Member" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member.ApprovalThresholdPolicy": { - "additionalProperties": false, - "properties": { - "ProposalDurationInHours": { - "type": "number" - }, - "ThresholdComparator": { - "type": "string" - }, - "ThresholdPercentage": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::ManagedBlockchain::Member.MemberConfiguration": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "MemberFrameworkConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.MemberFrameworkConfiguration" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member.MemberFabricConfiguration": { - "additionalProperties": false, - "properties": { - "AdminPassword": { - "type": "string" - }, - "AdminUsername": { - "type": "string" - } - }, - "required": [ - "AdminPassword", - "AdminUsername" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member.MemberFrameworkConfiguration": { - "additionalProperties": false, - "properties": { - "MemberFabricConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.MemberFabricConfiguration" - } - }, - "type": "object" - }, - "AWS::ManagedBlockchain::Member.NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Framework": { - "type": "string" - }, - "FrameworkVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NetworkFrameworkConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration" - }, - "VotingPolicy": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.VotingPolicy" - } - }, - "required": [ - "Framework", - "FrameworkVersion", - "Name", - "VotingPolicy" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member.NetworkFabricConfiguration": { - "additionalProperties": false, - "properties": { - "Edition": { - "type": "string" - } - }, - "required": [ - "Edition" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration": { - "additionalProperties": false, - "properties": { - "NetworkFabricConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.NetworkFabricConfiguration" - } - }, - "type": "object" - }, - "AWS::ManagedBlockchain::Member.VotingPolicy": { - "additionalProperties": false, - "properties": { - "ApprovalThresholdPolicy": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member.ApprovalThresholdPolicy" - } - }, - "type": "object" - }, - "AWS::ManagedBlockchain::Node": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MemberId": { - "type": "string" - }, - "NetworkId": { - "type": "string" - }, - "NodeConfiguration": { - "$ref": "#/definitions/AWS::ManagedBlockchain::Node.NodeConfiguration" - } - }, - "required": [ - "NetworkId", - "NodeConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ManagedBlockchain::Node" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ManagedBlockchain::Node.NodeConfiguration": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "InstanceType": { - "type": "string" - } - }, - "required": [ - "AvailabilityZone", - "InstanceType" - ], - "type": "object" - }, - "AWS::MediaConnect::Flow": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AvailabilityZone": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Source": { - "$ref": "#/definitions/AWS::MediaConnect::Flow.Source" - }, - "SourceFailoverConfig": { - "$ref": "#/definitions/AWS::MediaConnect::Flow.FailoverConfig" - } - }, - "required": [ - "Name", - "Source" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConnect::Flow" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConnect::Flow.Encryption": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "ConstantInitializationVector": { - "type": "string" - }, - "DeviceId": { - "type": "string" - }, - "KeyType": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SecretArn": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Algorithm", - "RoleArn" - ], - "type": "object" - }, - "AWS::MediaConnect::Flow.FailoverConfig": { - "additionalProperties": false, - "properties": { - "RecoveryWindow": { - "type": "number" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaConnect::Flow.Source": { - "additionalProperties": false, - "properties": { - "Decryption": { - "$ref": "#/definitions/AWS::MediaConnect::Flow.Encryption" - }, - "Description": { - "type": "string" - }, - "EntitlementArn": { - "type": "string" - }, - "IngestIp": { - "type": "string" - }, - "IngestPort": { - "type": "number" - }, - "MaxBitrate": { - "type": "number" - }, - "MaxLatency": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "SourceArn": { - "type": "string" - }, - "StreamId": { - "type": "string" - }, - "VpcInterfaceName": { - "type": "string" - }, - "WhitelistCidr": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaConnect::FlowEntitlement": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataTransferSubscriberFeePercent": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/AWS::MediaConnect::FlowEntitlement.Encryption" - }, - "EntitlementStatus": { - "type": "string" - }, - "FlowArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Subscribers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Description", - "FlowArn", - "Name", - "Subscribers" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConnect::FlowEntitlement" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowEntitlement.Encryption": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "ConstantInitializationVector": { - "type": "string" - }, - "DeviceId": { - "type": "string" - }, - "KeyType": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SecretArn": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Algorithm", - "RoleArn" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowOutput": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CidrAllowList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Destination": { - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/AWS::MediaConnect::FlowOutput.Encryption" - }, - "FlowArn": { - "type": "string" - }, - "MaxLatency": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "Protocol": { - "type": "string" - }, - "RemoteId": { - "type": "string" - }, - "SmoothingLatency": { - "type": "number" - }, - "StreamId": { - "type": "string" - }, - "VpcInterfaceAttachment": { - "$ref": "#/definitions/AWS::MediaConnect::FlowOutput.VpcInterfaceAttachment" - } - }, - "required": [ - "FlowArn", - "Protocol" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConnect::FlowOutput" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowOutput.Encryption": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "KeyType": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SecretArn": { - "type": "string" - } - }, - "required": [ - "Algorithm", - "RoleArn", - "SecretArn" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowOutput.VpcInterfaceAttachment": { - "additionalProperties": false, - "properties": { - "VpcInterfaceName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaConnect::FlowSource": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Decryption": { - "$ref": "#/definitions/AWS::MediaConnect::FlowSource.Encryption" - }, - "Description": { - "type": "string" - }, - "EntitlementArn": { - "type": "string" - }, - "FlowArn": { - "type": "string" - }, - "IngestPort": { - "type": "number" - }, - "MaxBitrate": { - "type": "number" - }, - "MaxLatency": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "StreamId": { - "type": "string" - }, - "VpcInterfaceName": { - "type": "string" - }, - "WhitelistCidr": { - "type": "string" - } - }, - "required": [ - "Description", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConnect::FlowSource" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowSource.Encryption": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "ConstantInitializationVector": { - "type": "string" - }, - "DeviceId": { - "type": "string" - }, - "KeyType": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SecretArn": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Algorithm", - "RoleArn" - ], - "type": "object" - }, - "AWS::MediaConnect::FlowVpcInterface": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FlowArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "FlowArn", - "Name", - "RoleArn", - "SecurityGroupIds", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConnect::FlowVpcInterface" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConvert::JobTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccelerationSettings": { - "$ref": "#/definitions/AWS::MediaConvert::JobTemplate.AccelerationSettings" - }, - "Category": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "HopDestinations": { - "items": { - "$ref": "#/definitions/AWS::MediaConvert::JobTemplate.HopDestination" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "Queue": { - "type": "string" - }, - "SettingsJson": { - "type": "object" - }, - "StatusUpdateInterval": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "SettingsJson" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConvert::JobTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConvert::JobTemplate.AccelerationSettings": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "AWS::MediaConvert::JobTemplate.HopDestination": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "number" - }, - "Queue": { - "type": "string" - }, - "WaitMinutes": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaConvert::Preset": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Category": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SettingsJson": { - "type": "object" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "SettingsJson" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConvert::Preset" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaConvert::Queue": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "PricingPlan": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaConvert::Queue" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::MediaLive::Channel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CdiInputSpecification": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CdiInputSpecification" - }, - "ChannelClass": { - "type": "string" - }, - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputDestination" - }, - "type": "array" - }, - "EncoderSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.EncoderSettings" - }, - "InputAttachments": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputAttachment" - }, - "type": "array" - }, - "InputSpecification": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputSpecification" - }, - "LogLevel": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Vpc": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VpcOutputSettings" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaLive::Channel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::MediaLive::Channel.AacSettings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "InputType": { - "type": "string" - }, - "Profile": { - "type": "string" - }, - "RateControlMode": { - "type": "string" - }, - "RawFormat": { - "type": "string" - }, - "SampleRate": { - "type": "number" - }, - "Spec": { - "type": "string" - }, - "VbrQuality": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Ac3Settings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "BitstreamMode": { - "type": "string" - }, - "CodingMode": { - "type": "string" - }, - "Dialnorm": { - "type": "number" - }, - "DrcProfile": { - "type": "string" - }, - "LfeFilter": { - "type": "string" - }, - "MetadataControl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AncillarySourceSettings": { - "additionalProperties": false, - "properties": { - "SourceAncillaryChannelNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.ArchiveContainerSettings": { - "additionalProperties": false, - "properties": { - "M2tsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.M2tsSettings" - }, - "RawSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.RawSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.ArchiveGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - }, - "RolloverInterval": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.ArchiveOutputSettings": { - "additionalProperties": false, - "properties": { - "ContainerSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.ArchiveContainerSettings" - }, - "Extension": { - "type": "string" - }, - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AribDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.AribSourceSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioChannelMapping": { - "additionalProperties": false, - "properties": { - "InputChannelLevels": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputChannelLevel" - }, - "type": "array" - }, - "OutputChannel": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioCodecSettings": { - "additionalProperties": false, - "properties": { - "AacSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AacSettings" - }, - "Ac3Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Ac3Settings" - }, - "Eac3Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Eac3Settings" - }, - "Mp2Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Mp2Settings" - }, - "PassThroughSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.PassThroughSettings" - }, - "WavSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.WavSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioDescription": { - "additionalProperties": false, - "properties": { - "AudioNormalizationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioNormalizationSettings" - }, - "AudioSelectorName": { - "type": "string" - }, - "AudioType": { - "type": "string" - }, - "AudioTypeControl": { - "type": "string" - }, - "CodecSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioCodecSettings" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageCodeControl": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RemixSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.RemixSettings" - }, - "StreamName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioLanguageSelection": { - "additionalProperties": false, - "properties": { - "LanguageCode": { - "type": "string" - }, - "LanguageSelectionPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioNormalizationSettings": { - "additionalProperties": false, - "properties": { - "Algorithm": { - "type": "string" - }, - "AlgorithmControl": { - "type": "string" - }, - "TargetLkfs": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioOnlyHlsSettings": { - "additionalProperties": false, - "properties": { - "AudioGroupId": { - "type": "string" - }, - "AudioOnlyImage": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "AudioTrackType": { - "type": "string" - }, - "SegmentType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioPidSelection": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioSelector": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioSelectorSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioSelectorSettings": { - "additionalProperties": false, - "properties": { - "AudioLanguageSelection": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioLanguageSelection" - }, - "AudioPidSelection": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioPidSelection" - }, - "AudioTrackSelection": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioTrackSelection" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioSilenceFailoverSettings": { - "additionalProperties": false, - "properties": { - "AudioSelectorName": { - "type": "string" - }, - "AudioSilenceThresholdMsec": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioTrack": { - "additionalProperties": false, - "properties": { - "Track": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AudioTrackSelection": { - "additionalProperties": false, - "properties": { - "Tracks": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioTrack" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AutomaticInputFailoverSettings": { - "additionalProperties": false, - "properties": { - "ErrorClearTimeMsec": { - "type": "number" - }, - "FailoverConditions": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FailoverCondition" - }, - "type": "array" - }, - "InputPreference": { - "type": "string" - }, - "SecondaryInputId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AvailBlanking": { - "additionalProperties": false, - "properties": { - "AvailBlankingImage": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AvailConfiguration": { - "additionalProperties": false, - "properties": { - "AvailSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AvailSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.AvailSettings": { - "additionalProperties": false, - "properties": { - "Scte35SpliceInsert": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte35SpliceInsert" - }, - "Scte35TimeSignalApos": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte35TimeSignalApos" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.BlackoutSlate": { - "additionalProperties": false, - "properties": { - "BlackoutSlateImage": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "NetworkEndBlackout": { - "type": "string" - }, - "NetworkEndBlackoutImage": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "NetworkId": { - "type": "string" - }, - "State": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.BurnInDestinationSettings": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "BackgroundColor": { - "type": "string" - }, - "BackgroundOpacity": { - "type": "number" - }, - "Font": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "FontColor": { - "type": "string" - }, - "FontOpacity": { - "type": "number" - }, - "FontResolution": { - "type": "number" - }, - "FontSize": { - "type": "string" - }, - "OutlineColor": { - "type": "string" - }, - "OutlineSize": { - "type": "number" - }, - "ShadowColor": { - "type": "string" - }, - "ShadowOpacity": { - "type": "number" - }, - "ShadowXOffset": { - "type": "number" - }, - "ShadowYOffset": { - "type": "number" - }, - "TeletextGridControl": { - "type": "string" - }, - "XPosition": { - "type": "number" - }, - "YPosition": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CaptionDescription": { - "additionalProperties": false, - "properties": { - "CaptionSelectorName": { - "type": "string" - }, - "DestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CaptionDestinationSettings" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageDescription": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CaptionDestinationSettings": { - "additionalProperties": false, - "properties": { - "AribDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AribDestinationSettings" - }, - "BurnInDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.BurnInDestinationSettings" - }, - "DvbSubDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.DvbSubDestinationSettings" - }, - "EbuTtDDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.EbuTtDDestinationSettings" - }, - "EmbeddedDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.EmbeddedDestinationSettings" - }, - "EmbeddedPlusScte20DestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.EmbeddedPlusScte20DestinationSettings" - }, - "RtmpCaptionInfoDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.RtmpCaptionInfoDestinationSettings" - }, - "Scte20PlusEmbeddedDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte20PlusEmbeddedDestinationSettings" - }, - "Scte27DestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte27DestinationSettings" - }, - "SmpteTtDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.SmpteTtDestinationSettings" - }, - "TeletextDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TeletextDestinationSettings" - }, - "TtmlDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TtmlDestinationSettings" - }, - "WebvttDestinationSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.WebvttDestinationSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CaptionLanguageMapping": { - "additionalProperties": false, - "properties": { - "CaptionChannel": { - "type": "number" - }, - "LanguageCode": { - "type": "string" - }, - "LanguageDescription": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CaptionSelector": { - "additionalProperties": false, - "properties": { - "LanguageCode": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CaptionSelectorSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CaptionSelectorSettings": { - "additionalProperties": false, - "properties": { - "AncillarySourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AncillarySourceSettings" - }, - "AribSourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AribSourceSettings" - }, - "DvbSubSourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.DvbSubSourceSettings" - }, - "EmbeddedSourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.EmbeddedSourceSettings" - }, - "Scte20SourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte20SourceSettings" - }, - "Scte27SourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Scte27SourceSettings" - }, - "TeletextSourceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TeletextSourceSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.CdiInputSpecification": { - "additionalProperties": false, - "properties": { - "Resolution": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.ColorSpacePassthroughSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.DvbNitSettings": { - "additionalProperties": false, - "properties": { - "NetworkId": { - "type": "number" - }, - "NetworkName": { - "type": "string" - }, - "RepInterval": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.DvbSdtSettings": { - "additionalProperties": false, - "properties": { - "OutputSdt": { - "type": "string" - }, - "RepInterval": { - "type": "number" - }, - "ServiceName": { - "type": "string" - }, - "ServiceProviderName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.DvbSubDestinationSettings": { - "additionalProperties": false, - "properties": { - "Alignment": { - "type": "string" - }, - "BackgroundColor": { - "type": "string" - }, - "BackgroundOpacity": { - "type": "number" - }, - "Font": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "FontColor": { - "type": "string" - }, - "FontOpacity": { - "type": "number" - }, - "FontResolution": { - "type": "number" - }, - "FontSize": { - "type": "string" - }, - "OutlineColor": { - "type": "string" - }, - "OutlineSize": { - "type": "number" - }, - "ShadowColor": { - "type": "string" - }, - "ShadowOpacity": { - "type": "number" - }, - "ShadowXOffset": { - "type": "number" - }, - "ShadowYOffset": { - "type": "number" - }, - "TeletextGridControl": { - "type": "string" - }, - "XPosition": { - "type": "number" - }, - "YPosition": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.DvbSubSourceSettings": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.DvbTdtSettings": { - "additionalProperties": false, - "properties": { - "RepInterval": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Eac3Settings": { - "additionalProperties": false, - "properties": { - "AttenuationControl": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BitstreamMode": { - "type": "string" - }, - "CodingMode": { - "type": "string" - }, - "DcFilter": { - "type": "string" - }, - "Dialnorm": { - "type": "number" - }, - "DrcLine": { - "type": "string" - }, - "DrcRf": { - "type": "string" - }, - "LfeControl": { - "type": "string" - }, - "LfeFilter": { - "type": "string" - }, - "LoRoCenterMixLevel": { - "type": "number" - }, - "LoRoSurroundMixLevel": { - "type": "number" - }, - "LtRtCenterMixLevel": { - "type": "number" - }, - "LtRtSurroundMixLevel": { - "type": "number" - }, - "MetadataControl": { - "type": "string" - }, - "PassthroughControl": { - "type": "string" - }, - "PhaseControl": { - "type": "string" - }, - "StereoDownmix": { - "type": "string" - }, - "SurroundExMode": { - "type": "string" - }, - "SurroundMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.EbuTtDDestinationSettings": { - "additionalProperties": false, - "properties": { - "FillLineGap": { - "type": "string" - }, - "FontFamily": { - "type": "string" - }, - "StyleControl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.EmbeddedDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.EmbeddedPlusScte20DestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.EmbeddedSourceSettings": { - "additionalProperties": false, - "properties": { - "Convert608To708": { - "type": "string" - }, - "Scte20Detection": { - "type": "string" - }, - "Source608ChannelNumber": { - "type": "number" - }, - "Source608TrackNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.EncoderSettings": { - "additionalProperties": false, - "properties": { - "AudioDescriptions": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioDescription" - }, - "type": "array" - }, - "AvailBlanking": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AvailBlanking" - }, - "AvailConfiguration": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AvailConfiguration" - }, - "BlackoutSlate": { - "$ref": "#/definitions/AWS::MediaLive::Channel.BlackoutSlate" - }, - "CaptionDescriptions": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CaptionDescription" - }, - "type": "array" - }, - "FeatureActivations": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FeatureActivations" - }, - "GlobalConfiguration": { - "$ref": "#/definitions/AWS::MediaLive::Channel.GlobalConfiguration" - }, - "NielsenConfiguration": { - "$ref": "#/definitions/AWS::MediaLive::Channel.NielsenConfiguration" - }, - "OutputGroups": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputGroup" - }, - "type": "array" - }, - "TimecodeConfig": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TimecodeConfig" - }, - "VideoDescriptions": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoDescription" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FailoverCondition": { - "additionalProperties": false, - "properties": { - "FailoverConditionSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FailoverConditionSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FailoverConditionSettings": { - "additionalProperties": false, - "properties": { - "AudioSilenceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioSilenceFailoverSettings" - }, - "InputLossSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLossFailoverSettings" - }, - "VideoBlackSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoBlackFailoverSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FeatureActivations": { - "additionalProperties": false, - "properties": { - "InputPrepareScheduleActions": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FecOutputSettings": { - "additionalProperties": false, - "properties": { - "ColumnDepth": { - "type": "number" - }, - "IncludeFec": { - "type": "string" - }, - "RowLength": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Fmp4HlsSettings": { - "additionalProperties": false, - "properties": { - "AudioRenditionSets": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "TimedMetadataBehavior": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FrameCaptureGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FrameCaptureOutputSettings": { - "additionalProperties": false, - "properties": { - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.FrameCaptureSettings": { - "additionalProperties": false, - "properties": { - "CaptureInterval": { - "type": "number" - }, - "CaptureIntervalUnits": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.GlobalConfiguration": { - "additionalProperties": false, - "properties": { - "InitialAudioGain": { - "type": "number" - }, - "InputEndAction": { - "type": "string" - }, - "InputLossBehavior": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLossBehavior" - }, - "OutputLockingMode": { - "type": "string" - }, - "OutputTimingSource": { - "type": "string" - }, - "SupportLowFramerateInputs": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H264ColorSpaceSettings": { - "additionalProperties": false, - "properties": { - "ColorSpacePassthroughSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.ColorSpacePassthroughSettings" - }, - "Rec601Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Rec601Settings" - }, - "Rec709Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Rec709Settings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H264FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TemporalFilterSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H264Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BufFillPct": { - "type": "number" - }, - "BufSize": { - "type": "number" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpaceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H264ColorSpaceSettings" - }, - "EntropyEncoding": { - "type": "string" - }, - "FilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H264FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FlickerAq": { - "type": "string" - }, - "ForceFieldPictures": { - "type": "string" - }, - "FramerateControl": { - "type": "string" - }, - "FramerateDenominator": { - "type": "number" - }, - "FramerateNumerator": { - "type": "number" - }, - "GopBReference": { - "type": "string" - }, - "GopClosedCadence": { - "type": "number" - }, - "GopNumBFrames": { - "type": "number" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "LookAheadRateControl": { - "type": "string" - }, - "MaxBitrate": { - "type": "number" - }, - "MinIInterval": { - "type": "number" - }, - "NumRefFrames": { - "type": "number" - }, - "ParControl": { - "type": "string" - }, - "ParDenominator": { - "type": "number" - }, - "ParNumerator": { - "type": "number" - }, - "Profile": { - "type": "string" - }, - "QualityLevel": { - "type": "string" - }, - "QvbrQualityLevel": { - "type": "number" - }, - "RateControlMode": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SceneChangeDetect": { - "type": "string" - }, - "Slices": { - "type": "number" - }, - "Softness": { - "type": "number" - }, - "SpatialAq": { - "type": "string" - }, - "SubgopLength": { - "type": "string" - }, - "Syntax": { - "type": "string" - }, - "TemporalAq": { - "type": "string" - }, - "TimecodeInsertion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H265ColorSpaceSettings": { - "additionalProperties": false, - "properties": { - "ColorSpacePassthroughSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.ColorSpacePassthroughSettings" - }, - "Hdr10Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Hdr10Settings" - }, - "Rec601Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Rec601Settings" - }, - "Rec709Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Rec709Settings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H265FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TemporalFilterSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.H265Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "AlternativeTransferFunction": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BufSize": { - "type": "number" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpaceSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H265ColorSpaceSettings" - }, - "FilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H265FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FlickerAq": { - "type": "string" - }, - "FramerateDenominator": { - "type": "number" - }, - "FramerateNumerator": { - "type": "number" - }, - "GopClosedCadence": { - "type": "number" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "Level": { - "type": "string" - }, - "LookAheadRateControl": { - "type": "string" - }, - "MaxBitrate": { - "type": "number" - }, - "MinIInterval": { - "type": "number" - }, - "ParDenominator": { - "type": "number" - }, - "ParNumerator": { - "type": "number" - }, - "Profile": { - "type": "string" - }, - "QvbrQualityLevel": { - "type": "number" - }, - "RateControlMode": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SceneChangeDetect": { - "type": "string" - }, - "Slices": { - "type": "number" - }, - "Tier": { - "type": "string" - }, - "TimecodeInsertion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Hdr10Settings": { - "additionalProperties": false, - "properties": { - "MaxCll": { - "type": "number" - }, - "MaxFall": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsAkamaiSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "number" - }, - "FilecacheDuration": { - "type": "number" - }, - "HttpTransferMode": { - "type": "string" - }, - "NumRetries": { - "type": "number" - }, - "RestartDelay": { - "type": "number" - }, - "Salt": { - "type": "string" - }, - "Token": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsBasicPutSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "number" - }, - "FilecacheDuration": { - "type": "number" - }, - "NumRetries": { - "type": "number" - }, - "RestartDelay": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsCdnSettings": { - "additionalProperties": false, - "properties": { - "HlsAkamaiSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsAkamaiSettings" - }, - "HlsBasicPutSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsBasicPutSettings" - }, - "HlsMediaStoreSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsMediaStoreSettings" - }, - "HlsWebdavSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsWebdavSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsGroupSettings": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BaseUrlContent": { - "type": "string" - }, - "BaseUrlContent1": { - "type": "string" - }, - "BaseUrlManifest": { - "type": "string" - }, - "BaseUrlManifest1": { - "type": "string" - }, - "CaptionLanguageMappings": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CaptionLanguageMapping" - }, - "type": "array" - }, - "CaptionLanguageSetting": { - "type": "string" - }, - "ClientCache": { - "type": "string" - }, - "CodecSpecification": { - "type": "string" - }, - "ConstantIv": { - "type": "string" - }, - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - }, - "DirectoryStructure": { - "type": "string" - }, - "DiscontinuityTags": { - "type": "string" - }, - "EncryptionType": { - "type": "string" - }, - "HlsCdnSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsCdnSettings" - }, - "HlsId3SegmentTagging": { - "type": "string" - }, - "IFrameOnlyPlaylists": { - "type": "string" - }, - "IncompleteSegmentBehavior": { - "type": "string" - }, - "IndexNSegments": { - "type": "number" - }, - "InputLossAction": { - "type": "string" - }, - "IvInManifest": { - "type": "string" - }, - "IvSource": { - "type": "string" - }, - "KeepSegments": { - "type": "number" - }, - "KeyFormat": { - "type": "string" - }, - "KeyFormatVersions": { - "type": "string" - }, - "KeyProviderSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.KeyProviderSettings" - }, - "ManifestCompression": { - "type": "string" - }, - "ManifestDurationFormat": { - "type": "string" - }, - "MinSegmentLength": { - "type": "number" - }, - "Mode": { - "type": "string" - }, - "OutputSelection": { - "type": "string" - }, - "ProgramDateTime": { - "type": "string" - }, - "ProgramDateTimePeriod": { - "type": "number" - }, - "RedundantManifest": { - "type": "string" - }, - "SegmentLength": { - "type": "number" - }, - "SegmentationMode": { - "type": "string" - }, - "SegmentsPerSubdirectory": { - "type": "number" - }, - "StreamInfResolution": { - "type": "string" - }, - "TimedMetadataId3Frame": { - "type": "string" - }, - "TimedMetadataId3Period": { - "type": "number" - }, - "TimestampDeltaMilliseconds": { - "type": "number" - }, - "TsFileMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsInputSettings": { - "additionalProperties": false, - "properties": { - "Bandwidth": { - "type": "number" - }, - "BufferSegments": { - "type": "number" - }, - "Retries": { - "type": "number" - }, - "RetryInterval": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsMediaStoreSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "number" - }, - "FilecacheDuration": { - "type": "number" - }, - "MediaStoreStorageClass": { - "type": "string" - }, - "NumRetries": { - "type": "number" - }, - "RestartDelay": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsOutputSettings": { - "additionalProperties": false, - "properties": { - "H265PackagingType": { - "type": "string" - }, - "HlsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsSettings" - }, - "NameModifier": { - "type": "string" - }, - "SegmentModifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsSettings": { - "additionalProperties": false, - "properties": { - "AudioOnlyHlsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioOnlyHlsSettings" - }, - "Fmp4HlsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Fmp4HlsSettings" - }, - "StandardHlsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.StandardHlsSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.HlsWebdavSettings": { - "additionalProperties": false, - "properties": { - "ConnectionRetryInterval": { - "type": "number" - }, - "FilecacheDuration": { - "type": "number" - }, - "HttpTransferMode": { - "type": "string" - }, - "NumRetries": { - "type": "number" - }, - "RestartDelay": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputAttachment": { - "additionalProperties": false, - "properties": { - "AutomaticInputFailoverSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AutomaticInputFailoverSettings" - }, - "InputAttachmentName": { - "type": "string" - }, - "InputId": { - "type": "string" - }, - "InputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputChannelLevel": { - "additionalProperties": false, - "properties": { - "Gain": { - "type": "number" - }, - "InputChannel": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputLocation": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "Uri": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputLossBehavior": { - "additionalProperties": false, - "properties": { - "BlackFrameMsec": { - "type": "number" - }, - "InputLossImageColor": { - "type": "string" - }, - "InputLossImageSlate": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "InputLossImageType": { - "type": "string" - }, - "RepeatFrameMsec": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputLossFailoverSettings": { - "additionalProperties": false, - "properties": { - "InputLossThresholdMsec": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputSettings": { - "additionalProperties": false, - "properties": { - "AudioSelectors": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioSelector" - }, - "type": "array" - }, - "CaptionSelectors": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.CaptionSelector" - }, - "type": "array" - }, - "DeblockFilter": { - "type": "string" - }, - "DenoiseFilter": { - "type": "string" - }, - "FilterStrength": { - "type": "number" - }, - "InputFilter": { - "type": "string" - }, - "NetworkInputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.NetworkInputSettings" - }, - "Smpte2038DataPreference": { - "type": "string" - }, - "SourceEndBehavior": { - "type": "string" - }, - "VideoSelector": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoSelector" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.InputSpecification": { - "additionalProperties": false, - "properties": { - "Codec": { - "type": "string" - }, - "MaximumBitrate": { - "type": "string" - }, - "Resolution": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.KeyProviderSettings": { - "additionalProperties": false, - "properties": { - "StaticKeySettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.StaticKeySettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.M2tsSettings": { - "additionalProperties": false, - "properties": { - "AbsentInputAudioBehavior": { - "type": "string" - }, - "Arib": { - "type": "string" - }, - "AribCaptionsPid": { - "type": "string" - }, - "AribCaptionsPidControl": { - "type": "string" - }, - "AudioBufferModel": { - "type": "string" - }, - "AudioFramesPerPes": { - "type": "number" - }, - "AudioPids": { - "type": "string" - }, - "AudioStreamType": { - "type": "string" - }, - "Bitrate": { - "type": "number" - }, - "BufferModel": { - "type": "string" - }, - "CcDescriptor": { - "type": "string" - }, - "DvbNitSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.DvbNitSettings" - }, - "DvbSdtSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.DvbSdtSettings" - }, - "DvbSubPids": { - "type": "string" - }, - "DvbTdtSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.DvbTdtSettings" - }, - "DvbTeletextPid": { - "type": "string" - }, - "Ebif": { - "type": "string" - }, - "EbpAudioInterval": { - "type": "string" - }, - "EbpLookaheadMs": { - "type": "number" - }, - "EbpPlacement": { - "type": "string" - }, - "EcmPid": { - "type": "string" - }, - "EsRateInPes": { - "type": "string" - }, - "EtvPlatformPid": { - "type": "string" - }, - "EtvSignalPid": { - "type": "string" - }, - "FragmentTime": { - "type": "number" - }, - "Klv": { - "type": "string" - }, - "KlvDataPids": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "NullPacketBitrate": { - "type": "number" - }, - "PatInterval": { - "type": "number" - }, - "PcrControl": { - "type": "string" - }, - "PcrPeriod": { - "type": "number" - }, - "PcrPid": { - "type": "string" - }, - "PmtInterval": { - "type": "number" - }, - "PmtPid": { - "type": "string" - }, - "ProgramNum": { - "type": "number" - }, - "RateMode": { - "type": "string" - }, - "Scte27Pids": { - "type": "string" - }, - "Scte35Control": { - "type": "string" - }, - "Scte35Pid": { - "type": "string" - }, - "SegmentationMarkers": { - "type": "string" - }, - "SegmentationStyle": { - "type": "string" - }, - "SegmentationTime": { - "type": "number" - }, - "TimedMetadataBehavior": { - "type": "string" - }, - "TimedMetadataPid": { - "type": "string" - }, - "TransportStreamId": { - "type": "number" - }, - "VideoPid": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.M3u8Settings": { - "additionalProperties": false, - "properties": { - "AudioFramesPerPes": { - "type": "number" - }, - "AudioPids": { - "type": "string" - }, - "EcmPid": { - "type": "string" - }, - "NielsenId3Behavior": { - "type": "string" - }, - "PatInterval": { - "type": "number" - }, - "PcrControl": { - "type": "string" - }, - "PcrPeriod": { - "type": "number" - }, - "PcrPid": { - "type": "string" - }, - "PmtInterval": { - "type": "number" - }, - "PmtPid": { - "type": "string" - }, - "ProgramNum": { - "type": "number" - }, - "Scte35Behavior": { - "type": "string" - }, - "Scte35Pid": { - "type": "string" - }, - "TimedMetadataBehavior": { - "type": "string" - }, - "TimedMetadataPid": { - "type": "string" - }, - "TransportStreamId": { - "type": "number" - }, - "VideoPid": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MediaPackageGroupSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings": { - "additionalProperties": false, - "properties": { - "ChannelId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MediaPackageOutputSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.Mp2Settings": { - "additionalProperties": false, - "properties": { - "Bitrate": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "SampleRate": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Mpeg2FilterSettings": { - "additionalProperties": false, - "properties": { - "TemporalFilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.TemporalFilterSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Mpeg2Settings": { - "additionalProperties": false, - "properties": { - "AdaptiveQuantization": { - "type": "string" - }, - "AfdSignaling": { - "type": "string" - }, - "ColorMetadata": { - "type": "string" - }, - "ColorSpace": { - "type": "string" - }, - "DisplayAspectRatio": { - "type": "string" - }, - "FilterSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Mpeg2FilterSettings" - }, - "FixedAfd": { - "type": "string" - }, - "FramerateDenominator": { - "type": "number" - }, - "FramerateNumerator": { - "type": "number" - }, - "GopClosedCadence": { - "type": "number" - }, - "GopNumBFrames": { - "type": "number" - }, - "GopSize": { - "type": "number" - }, - "GopSizeUnits": { - "type": "string" - }, - "ScanType": { - "type": "string" - }, - "SubgopLength": { - "type": "string" - }, - "TimecodeInsertion": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MsSmoothGroupSettings": { - "additionalProperties": false, - "properties": { - "AcquisitionPointId": { - "type": "string" - }, - "AudioOnlyTimecodeControl": { - "type": "string" - }, - "CertificateMode": { - "type": "string" - }, - "ConnectionRetryInterval": { - "type": "number" - }, - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - }, - "EventId": { - "type": "string" - }, - "EventIdMode": { - "type": "string" - }, - "EventStopBehavior": { - "type": "string" - }, - "FilecacheDuration": { - "type": "number" - }, - "FragmentLength": { - "type": "number" - }, - "InputLossAction": { - "type": "string" - }, - "NumRetries": { - "type": "number" - }, - "RestartDelay": { - "type": "number" - }, - "SegmentationMode": { - "type": "string" - }, - "SendDelayMs": { - "type": "number" - }, - "SparseTrackType": { - "type": "string" - }, - "StreamManifestBehavior": { - "type": "string" - }, - "TimestampOffset": { - "type": "string" - }, - "TimestampOffsetMode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MsSmoothOutputSettings": { - "additionalProperties": false, - "properties": { - "H265PackagingType": { - "type": "string" - }, - "NameModifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MultiplexGroupSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.MultiplexOutputSettings": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings": { - "additionalProperties": false, - "properties": { - "MultiplexId": { - "type": "string" - }, - "ProgramName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.NetworkInputSettings": { - "additionalProperties": false, - "properties": { - "HlsInputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsInputSettings" - }, - "ServerValidation": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.NielsenConfiguration": { - "additionalProperties": false, - "properties": { - "DistributorId": { - "type": "string" - }, - "NielsenPcmToId3Tagging": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Output": { - "additionalProperties": false, - "properties": { - "AudioDescriptionNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CaptionDescriptionNames": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OutputName": { - "type": "string" - }, - "OutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputSettings" - }, - "VideoDescriptionName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputDestination": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "MediaPackageSettings": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MediaPackageOutputDestinationSettings" - }, - "type": "array" - }, - "MultiplexSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MultiplexProgramChannelDestinationSettings" - }, - "Settings": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputDestinationSettings" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputDestinationSettings": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "StreamName": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputGroup": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "OutputGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputGroupSettings" - }, - "Outputs": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Output" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputGroupSettings": { - "additionalProperties": false, - "properties": { - "ArchiveGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.ArchiveGroupSettings" - }, - "FrameCaptureGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FrameCaptureGroupSettings" - }, - "HlsGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsGroupSettings" - }, - "MediaPackageGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MediaPackageGroupSettings" - }, - "MsSmoothGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MsSmoothGroupSettings" - }, - "MultiplexGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MultiplexGroupSettings" - }, - "RtmpGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.RtmpGroupSettings" - }, - "UdpGroupSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.UdpGroupSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputLocationRef": { - "additionalProperties": false, - "properties": { - "DestinationRefId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.OutputSettings": { - "additionalProperties": false, - "properties": { - "ArchiveOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.ArchiveOutputSettings" - }, - "FrameCaptureOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FrameCaptureOutputSettings" - }, - "HlsOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.HlsOutputSettings" - }, - "MediaPackageOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MediaPackageOutputSettings" - }, - "MsSmoothOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MsSmoothOutputSettings" - }, - "MultiplexOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.MultiplexOutputSettings" - }, - "RtmpOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.RtmpOutputSettings" - }, - "UdpOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.UdpOutputSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.PassThroughSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.RawSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.Rec601Settings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.Rec709Settings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.RemixSettings": { - "additionalProperties": false, - "properties": { - "ChannelMappings": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Channel.AudioChannelMapping" - }, - "type": "array" - }, - "ChannelsIn": { - "type": "number" - }, - "ChannelsOut": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.RtmpCaptionInfoDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.RtmpGroupSettings": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AuthenticationScheme": { - "type": "string" - }, - "CacheFullBehavior": { - "type": "string" - }, - "CacheLength": { - "type": "number" - }, - "CaptionData": { - "type": "string" - }, - "InputLossAction": { - "type": "string" - }, - "RestartDelay": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.RtmpOutputSettings": { - "additionalProperties": false, - "properties": { - "CertificateMode": { - "type": "string" - }, - "ConnectionRetryInterval": { - "type": "number" - }, - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - }, - "NumRetries": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte20PlusEmbeddedDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte20SourceSettings": { - "additionalProperties": false, - "properties": { - "Convert608To708": { - "type": "string" - }, - "Source608ChannelNumber": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte27DestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte27SourceSettings": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte35SpliceInsert": { - "additionalProperties": false, - "properties": { - "AdAvailOffset": { - "type": "number" - }, - "NoRegionalBlackoutFlag": { - "type": "string" - }, - "WebDeliveryAllowedFlag": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.Scte35TimeSignalApos": { - "additionalProperties": false, - "properties": { - "AdAvailOffset": { - "type": "number" - }, - "NoRegionalBlackoutFlag": { - "type": "string" - }, - "WebDeliveryAllowedFlag": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.SmpteTtDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.StandardHlsSettings": { - "additionalProperties": false, - "properties": { - "AudioRenditionSets": { - "type": "string" - }, - "M3u8Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.M3u8Settings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.StaticKeySettings": { - "additionalProperties": false, - "properties": { - "KeyProviderServer": { - "$ref": "#/definitions/AWS::MediaLive::Channel.InputLocation" - }, - "StaticKeyValue": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.TeletextDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Channel.TeletextSourceSettings": { - "additionalProperties": false, - "properties": { - "PageNumber": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.TemporalFilterSettings": { - "additionalProperties": false, - "properties": { - "PostFilterSharpening": { - "type": "string" - }, - "Strength": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.TimecodeConfig": { - "additionalProperties": false, - "properties": { - "Source": { - "type": "string" - }, - "SyncThreshold": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.TtmlDestinationSettings": { - "additionalProperties": false, - "properties": { - "StyleControl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.UdpContainerSettings": { - "additionalProperties": false, - "properties": { - "M2tsSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.M2tsSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.UdpGroupSettings": { - "additionalProperties": false, - "properties": { - "InputLossAction": { - "type": "string" - }, - "TimedMetadataId3Frame": { - "type": "string" - }, - "TimedMetadataId3Period": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.UdpOutputSettings": { - "additionalProperties": false, - "properties": { - "BufferMsec": { - "type": "number" - }, - "ContainerSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.UdpContainerSettings" - }, - "Destination": { - "$ref": "#/definitions/AWS::MediaLive::Channel.OutputLocationRef" - }, - "FecOutputSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FecOutputSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoBlackFailoverSettings": { - "additionalProperties": false, - "properties": { - "BlackDetectThreshold": { - "type": "number" - }, - "VideoBlackThresholdMsec": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoCodecSettings": { - "additionalProperties": false, - "properties": { - "FrameCaptureSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.FrameCaptureSettings" - }, - "H264Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H264Settings" - }, - "H265Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.H265Settings" - }, - "Mpeg2Settings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.Mpeg2Settings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoDescription": { - "additionalProperties": false, - "properties": { - "CodecSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoCodecSettings" - }, - "Height": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "RespondToAfd": { - "type": "string" - }, - "ScalingBehavior": { - "type": "string" - }, - "Sharpness": { - "type": "number" - }, - "Width": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoSelector": { - "additionalProperties": false, - "properties": { - "ColorSpace": { - "type": "string" - }, - "ColorSpaceUsage": { - "type": "string" - }, - "SelectorSettings": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoSelectorSettings" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoSelectorPid": { - "additionalProperties": false, - "properties": { - "Pid": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoSelectorProgramId": { - "additionalProperties": false, - "properties": { - "ProgramId": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VideoSelectorSettings": { - "additionalProperties": false, - "properties": { - "VideoSelectorPid": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoSelectorPid" - }, - "VideoSelectorProgramId": { - "$ref": "#/definitions/AWS::MediaLive::Channel.VideoSelectorProgramId" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.VpcOutputSettings": { - "additionalProperties": false, - "properties": { - "PublicAddressAllocationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.WavSettings": { - "additionalProperties": false, - "properties": { - "BitDepth": { - "type": "number" - }, - "CodingMode": { - "type": "string" - }, - "SampleRate": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaLive::Channel.WebvttDestinationSettings": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::MediaLive::Input": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Input.InputDestinationRequest" - }, - "type": "array" - }, - "InputDevices": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Input.InputDeviceSettings" - }, - "type": "array" - }, - "InputSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MediaConnectFlows": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Input.MediaConnectFlowRequest" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Sources": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::Input.InputSourceRequest" - }, - "type": "array" - }, - "Tags": { - "type": "object" - }, - "Type": { - "type": "string" - }, - "Vpc": { - "$ref": "#/definitions/AWS::MediaLive::Input.InputVpcRequest" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaLive::Input" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::MediaLive::Input.InputDestinationRequest": { - "additionalProperties": false, - "properties": { - "StreamName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Input.InputDeviceRequest": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Input.InputDeviceSettings": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Input.InputSourceRequest": { - "additionalProperties": false, - "properties": { - "PasswordParam": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::Input.InputVpcRequest": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::MediaLive::Input.MediaConnectFlowRequest": { - "additionalProperties": false, - "properties": { - "FlowArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaLive::InputSecurityGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "type": "object" - }, - "WhitelistRules": { - "items": { - "$ref": "#/definitions/AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaLive::InputSecurityGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::MediaLive::InputSecurityGroup.InputWhitelistRuleCidr": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaPackage::Asset": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EgressEndpoints": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::Asset.EgressEndpoint" - }, - "type": "array" - }, - "Id": { - "type": "string" - }, - "PackagingGroupId": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "SourceArn": { - "type": "string" - }, - "SourceRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Id", - "PackagingGroupId", - "SourceArn", - "SourceRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaPackage::Asset" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaPackage::Asset.EgressEndpoint": { - "additionalProperties": false, - "properties": { - "PackagingConfigurationId": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "PackagingConfigurationId", - "Url" - ], - "type": "object" - }, - "AWS::MediaPackage::Channel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaPackage::Channel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Authorization": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.Authorization" - }, - "ChannelId": { - "type": "string" - }, - "CmafPackage": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.CmafPackage" - }, - "DashPackage": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.DashPackage" - }, - "Description": { - "type": "string" - }, - "HlsPackage": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.HlsPackage" - }, - "Id": { - "type": "string" - }, - "ManifestName": { - "type": "string" - }, - "MssPackage": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.MssPackage" - }, - "Origination": { - "type": "string" - }, - "StartoverWindowSeconds": { - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TimeDelaySeconds": { - "type": "number" - }, - "Whitelist": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ChannelId", - "Id" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaPackage::OriginEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.Authorization": { - "additionalProperties": false, - "properties": { - "CdnIdentifierSecret": { - "type": "string" - }, - "SecretsRoleArn": { - "type": "string" - } - }, - "required": [ - "CdnIdentifierSecret", - "SecretsRoleArn" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.CmafEncryption": { - "additionalProperties": false, - "properties": { - "KeyRotationIntervalSeconds": { - "type": "number" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.CmafPackage": { - "additionalProperties": false, - "properties": { - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.CmafEncryption" - }, - "HlsManifests": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.HlsManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "SegmentPrefix": { - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection" - } - }, - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.DashEncryption": { - "additionalProperties": false, - "properties": { - "KeyRotationIntervalSeconds": { - "type": "number" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.DashPackage": { - "additionalProperties": false, - "properties": { - "AdTriggers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.DashEncryption" - }, - "ManifestLayout": { - "type": "string" - }, - "ManifestWindowSeconds": { - "type": "number" - }, - "MinBufferTimeSeconds": { - "type": "number" - }, - "MinUpdatePeriodSeconds": { - "type": "number" - }, - "PeriodTriggers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Profile": { - "type": "string" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "SegmentTemplateFormat": { - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection" - }, - "SuggestedPresentationDelaySeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.HlsEncryption": { - "additionalProperties": false, - "properties": { - "ConstantInitializationVector": { - "type": "string" - }, - "EncryptionMethod": { - "type": "string" - }, - "KeyRotationIntervalSeconds": { - "type": "number" - }, - "RepeatExtXKey": { - "type": "boolean" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.HlsManifest": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "type": "string" - }, - "AdTriggers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "type": "string" - }, - "Id": { - "type": "string" - }, - "IncludeIframeOnlyStream": { - "type": "boolean" - }, - "ManifestName": { - "type": "string" - }, - "PlaylistType": { - "type": "string" - }, - "PlaylistWindowSeconds": { - "type": "number" - }, - "ProgramDateTimeIntervalSeconds": { - "type": "number" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.HlsPackage": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "type": "string" - }, - "AdTriggers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdsOnDeliveryRestrictions": { - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.HlsEncryption" - }, - "IncludeIframeOnlyStream": { - "type": "boolean" - }, - "PlaylistType": { - "type": "string" - }, - "PlaylistWindowSeconds": { - "type": "number" - }, - "ProgramDateTimeIntervalSeconds": { - "type": "number" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection" - }, - "UseAudioRenditionGroup": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.MssEncryption": { - "additionalProperties": false, - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.MssPackage": { - "additionalProperties": false, - "properties": { - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.MssEncryption" - }, - "ManifestWindowSeconds": { - "type": "number" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection" - } - }, - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.SpekeKeyProvider": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "ResourceId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "SystemIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "ResourceId", - "RoleArn", - "SystemIds", - "Url" - ], - "type": "object" - }, - "AWS::MediaPackage::OriginEndpoint.StreamSelection": { - "additionalProperties": false, - "properties": { - "MaxVideoBitsPerSecond": { - "type": "number" - }, - "MinVideoBitsPerSecond": { - "type": "number" - }, - "StreamOrder": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CmafPackage": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.CmafPackage" - }, - "DashPackage": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.DashPackage" - }, - "HlsPackage": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.HlsPackage" - }, - "Id": { - "type": "string" - }, - "MssPackage": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.MssPackage" - }, - "PackagingGroupId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Id", - "PackagingGroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaPackage::PackagingConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.CmafEncryption": { - "additionalProperties": false, - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.CmafPackage": { - "additionalProperties": false, - "properties": { - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.CmafEncryption" - }, - "HlsManifests": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.HlsManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "type": "number" - } - }, - "required": [ - "HlsManifests" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.DashEncryption": { - "additionalProperties": false, - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.DashManifest": { - "additionalProperties": false, - "properties": { - "ManifestLayout": { - "type": "string" - }, - "ManifestName": { - "type": "string" - }, - "MinBufferTimeSeconds": { - "type": "number" - }, - "Profile": { - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.StreamSelection" - } - }, - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.DashPackage": { - "additionalProperties": false, - "properties": { - "DashManifests": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.DashManifest" - }, - "type": "array" - }, - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.DashEncryption" - }, - "PeriodTriggers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "SegmentTemplateFormat": { - "type": "string" - } - }, - "required": [ - "DashManifests" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.HlsEncryption": { - "additionalProperties": false, - "properties": { - "ConstantInitializationVector": { - "type": "string" - }, - "EncryptionMethod": { - "type": "string" - }, - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.HlsManifest": { - "additionalProperties": false, - "properties": { - "AdMarkers": { - "type": "string" - }, - "IncludeIframeOnlyStream": { - "type": "boolean" - }, - "ManifestName": { - "type": "string" - }, - "ProgramDateTimeIntervalSeconds": { - "type": "number" - }, - "RepeatExtXKey": { - "type": "boolean" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.StreamSelection" - } - }, - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.HlsPackage": { - "additionalProperties": false, - "properties": { - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.HlsEncryption" - }, - "HlsManifests": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.HlsManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "type": "number" - }, - "UseAudioRenditionGroup": { - "type": "boolean" - } - }, - "required": [ - "HlsManifests" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.MssEncryption": { - "additionalProperties": false, - "properties": { - "SpekeKeyProvider": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider" - } - }, - "required": [ - "SpekeKeyProvider" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.MssManifest": { - "additionalProperties": false, - "properties": { - "ManifestName": { - "type": "string" - }, - "StreamSelection": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.StreamSelection" - } - }, - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.MssPackage": { - "additionalProperties": false, - "properties": { - "Encryption": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.MssEncryption" - }, - "MssManifests": { - "items": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.MssManifest" - }, - "type": "array" - }, - "SegmentDurationSeconds": { - "type": "number" - } - }, - "required": [ - "MssManifests" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.SpekeKeyProvider": { - "additionalProperties": false, - "properties": { - "RoleArn": { - "type": "string" - }, - "SystemIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "RoleArn", - "SystemIds", - "Url" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingConfiguration.StreamSelection": { - "additionalProperties": false, - "properties": { - "MaxVideoBitsPerSecond": { - "type": "number" - }, - "MinVideoBitsPerSecond": { - "type": "number" - }, - "StreamOrder": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::MediaPackage::PackagingGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Authorization": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingGroup.Authorization" - }, - "Id": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaPackage::PackagingGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaPackage::PackagingGroup.Authorization": { - "additionalProperties": false, - "properties": { - "CdnIdentifierSecret": { - "type": "string" - }, - "SecretsRoleArn": { - "type": "string" - } - }, - "required": [ - "CdnIdentifierSecret", - "SecretsRoleArn" - ], - "type": "object" - }, - "AWS::MediaStore::Container": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessLoggingEnabled": { - "type": "boolean" - }, - "ContainerName": { - "type": "string" - }, - "CorsPolicy": { - "items": { - "$ref": "#/definitions/AWS::MediaStore::Container.CorsRule" - }, - "type": "array" - }, - "LifecyclePolicy": { - "type": "string" - }, - "MetricPolicy": { - "$ref": "#/definitions/AWS::MediaStore::Container.MetricPolicy" - }, - "Policy": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ContainerName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::MediaStore::Container" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::MediaStore::Container.CorsRule": { - "additionalProperties": false, - "properties": { - "AllowedHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ExposeHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MaxAgeSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::MediaStore::Container.MetricPolicy": { - "additionalProperties": false, - "properties": { - "ContainerLevelMetrics": { - "type": "string" - }, - "MetricPolicyRules": { - "items": { - "$ref": "#/definitions/AWS::MediaStore::Container.MetricPolicyRule" - }, - "type": "array" - } - }, - "required": [ - "ContainerLevelMetrics" - ], - "type": "object" - }, - "AWS::MediaStore::Container.MetricPolicyRule": { - "additionalProperties": false, - "properties": { - "ObjectGroup": { - "type": "string" - }, - "ObjectGroupName": { - "type": "string" - } - }, - "required": [ - "ObjectGroup", - "ObjectGroupName" - ], - "type": "object" - }, - "AWS::Neptune::DBCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssociatedRoles": { - "items": { - "$ref": "#/definitions/AWS::Neptune::DBCluster.DBClusterRole" - }, - "type": "array" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BackupRetentionPeriod": { - "type": "number" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBClusterParameterGroupName": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "DeletionProtection": { - "type": "boolean" - }, - "EnableCloudwatchLogsExports": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EngineVersion": { - "type": "string" - }, - "IamAuthEnabled": { - "type": "boolean" - }, - "KmsKeyId": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "RestoreToTime": { - "type": "string" - }, - "RestoreType": { - "type": "string" - }, - "SnapshotIdentifier": { - "type": "string" - }, - "SourceDBClusterIdentifier": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UseLatestRestorableTime": { - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Neptune::DBCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Neptune::DBCluster.DBClusterRole": { - "additionalProperties": false, - "properties": { - "FeatureName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "AWS::Neptune::DBClusterParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "Family", - "Parameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Neptune::DBClusterParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Neptune::DBInstance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowMajorVersionUpgrade": { - "type": "boolean" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBInstanceClass": { - "type": "string" - }, - "DBInstanceIdentifier": { - "type": "string" - }, - "DBParameterGroupName": { - "type": "string" - }, - "DBSnapshotIdentifier": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBInstanceClass" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Neptune::DBInstance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Neptune::DBParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "Family", - "Parameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Neptune::DBParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Neptune::DBSubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DBSubnetGroupDescription": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Neptune::DBSubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkFirewall::Firewall": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeleteProtection": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "FirewallName": { - "type": "string" - }, - "FirewallPolicyArn": { - "type": "string" - }, - "FirewallPolicyChangeProtection": { - "type": "boolean" - }, - "SubnetChangeProtection": { - "type": "boolean" - }, - "SubnetMappings": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::Firewall.SubnetMapping" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "FirewallName", - "FirewallPolicyArn", - "SubnetMappings", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkFirewall::Firewall" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkFirewall::Firewall.SubnetMapping": { - "additionalProperties": false, - "properties": { - "SubnetId": { - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "FirewallPolicy": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy" - }, - "FirewallPolicyName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "FirewallPolicy", - "FirewallPolicyName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkFirewall::FirewallPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.ActionDefinition": { - "additionalProperties": false, - "properties": { - "PublishMetricAction": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.PublishMetricAction" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.CustomAction": { - "additionalProperties": false, - "properties": { - "ActionDefinition": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.ActionDefinition" - }, - "ActionName": { - "type": "string" - } - }, - "required": [ - "ActionDefinition", - "ActionName" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.Dimension": { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy": { - "additionalProperties": false, - "properties": { - "StatefulRuleGroupReferences": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupReference" - }, - "type": "array" - }, - "StatelessCustomActions": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.CustomAction" - }, - "type": "array" - }, - "StatelessDefaultActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StatelessFragmentDefaultActions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StatelessRuleGroupReferences": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatelessRuleGroupReference" - }, - "type": "array" - } - }, - "required": [ - "StatelessDefaultActions", - "StatelessFragmentDefaultActions" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.PublishMetricAction": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.Dimension" - }, - "type": "array" - } - }, - "required": [ - "Dimensions" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupReference": { - "additionalProperties": false, - "properties": { - "ResourceArn": { - "type": "string" - } - }, - "required": [ - "ResourceArn" - ], - "type": "object" - }, - "AWS::NetworkFirewall::FirewallPolicy.StatelessRuleGroupReference": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "number" - }, - "ResourceArn": { - "type": "string" - } - }, - "required": [ - "Priority", - "ResourceArn" - ], - "type": "object" - }, - "AWS::NetworkFirewall::LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "FirewallArn": { - "type": "string" - }, - "FirewallName": { - "type": "string" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration" - } - }, - "required": [ - "FirewallArn", - "LoggingConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkFirewall::LoggingConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkFirewall::LoggingConfiguration.LogDestinationConfig": { - "additionalProperties": false, - "properties": { - "LogDestination": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "LogDestinationType": { - "type": "string" - }, - "LogType": { - "type": "string" - } - }, - "required": [ - "LogDestination", - "LogDestinationType", - "LogType" - ], - "type": "object" - }, - "AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "LogDestinationConfigs": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::LoggingConfiguration.LogDestinationConfig" - }, - "type": "array" - } - }, - "required": [ - "LogDestinationConfigs" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Capacity": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "RuleGroup": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleGroup" - }, - "RuleGroupName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Capacity", - "RuleGroupName", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkFirewall::RuleGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.ActionDefinition": { - "additionalProperties": false, - "properties": { - "PublishMetricAction": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.PublishMetricAction" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.Address": { - "additionalProperties": false, - "properties": { - "AddressDefinition": { - "type": "string" - } - }, - "required": [ - "AddressDefinition" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.CustomAction": { - "additionalProperties": false, - "properties": { - "ActionDefinition": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.ActionDefinition" - }, - "ActionName": { - "type": "string" - } - }, - "required": [ - "ActionDefinition", - "ActionName" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.Dimension": { - "additionalProperties": false, - "properties": { - "Value": { - "type": "string" - } - }, - "required": [ - "Value" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.Header": { - "additionalProperties": false, - "properties": { - "Destination": { - "type": "string" - }, - "DestinationPort": { - "type": "string" - }, - "Direction": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "Source": { - "type": "string" - }, - "SourcePort": { - "type": "string" - } - }, - "required": [ - "Destination", - "DestinationPort", - "Direction", - "Protocol", - "Source", - "SourcePort" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.IPSet": { - "additionalProperties": false, - "properties": { - "Definition": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.MatchAttributes": { - "additionalProperties": false, - "properties": { - "DestinationPorts": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.PortRange" - }, - "type": "array" - }, - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.Address" - }, - "type": "array" - }, - "Protocols": { - "items": { - "type": "number" - }, - "type": "array" - }, - "SourcePorts": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.PortRange" - }, - "type": "array" - }, - "Sources": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.Address" - }, - "type": "array" - }, - "TCPFlags": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.TCPFlagField" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.PortRange": { - "additionalProperties": false, - "properties": { - "FromPort": { - "type": "number" - }, - "ToPort": { - "type": "number" - } - }, - "required": [ - "FromPort", - "ToPort" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.PortSet": { - "additionalProperties": false, - "properties": { - "Definition": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.PublishMetricAction": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.Dimension" - }, - "type": "array" - } - }, - "required": [ - "Dimensions" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RuleDefinition": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "MatchAttributes": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.MatchAttributes" - } - }, - "required": [ - "Actions", - "MatchAttributes" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RuleGroup": { - "additionalProperties": false, - "properties": { - "RuleVariables": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleVariables" - }, - "RulesSource": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RulesSource" - } - }, - "required": [ - "RulesSource" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RuleOption": { - "additionalProperties": false, - "properties": { - "Keyword": { - "type": "string" - }, - "Settings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Keyword" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RuleVariables": { - "additionalProperties": false, - "properties": { - "IPSets": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.IPSet" - } - }, - "type": "object" - }, - "PortSets": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.PortSet" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RulesSource": { - "additionalProperties": false, - "properties": { - "RulesSourceList": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RulesSourceList" - }, - "RulesString": { - "type": "string" - }, - "StatefulRules": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.StatefulRule" - }, - "type": "array" - }, - "StatelessRulesAndCustomActions": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.StatelessRulesAndCustomActions" - } - }, - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.RulesSourceList": { - "additionalProperties": false, - "properties": { - "GeneratedRulesType": { - "type": "string" - }, - "TargetTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Targets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "GeneratedRulesType", - "TargetTypes", - "Targets" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.StatefulRule": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Header": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.Header" - }, - "RuleOptions": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleOption" - }, - "type": "array" - } - }, - "required": [ - "Action", - "Header", - "RuleOptions" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.StatelessRule": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "number" - }, - "RuleDefinition": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleDefinition" - } - }, - "required": [ - "Priority", - "RuleDefinition" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.StatelessRulesAndCustomActions": { - "additionalProperties": false, - "properties": { - "CustomActions": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.CustomAction" - }, - "type": "array" - }, - "StatelessRules": { - "items": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.StatelessRule" - }, - "type": "array" - } - }, - "required": [ - "StatelessRules" - ], - "type": "object" - }, - "AWS::NetworkFirewall::RuleGroup.TCPFlagField": { - "additionalProperties": false, - "properties": { - "Flags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Masks": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Flags" - ], - "type": "object" - }, - "AWS::NetworkManager::CustomerGatewayAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CustomerGatewayArn": { - "type": "string" - }, - "DeviceId": { - "type": "string" - }, - "GlobalNetworkId": { - "type": "string" - }, - "LinkId": { - "type": "string" - } - }, - "required": [ - "CustomerGatewayArn", - "DeviceId", - "GlobalNetworkId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::CustomerGatewayAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkManager::Device": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GlobalNetworkId": { - "type": "string" - }, - "Location": { - "$ref": "#/definitions/AWS::NetworkManager::Device.Location" - }, - "Model": { - "type": "string" - }, - "SerialNumber": { - "type": "string" - }, - "SiteId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - }, - "Vendor": { - "type": "string" - } - }, - "required": [ - "GlobalNetworkId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::Device" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkManager::Device.Location": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Latitude": { - "type": "string" - }, - "Longitude": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::NetworkManager::GlobalNetwork": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::GlobalNetwork" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::NetworkManager::Link": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Bandwidth": { - "$ref": "#/definitions/AWS::NetworkManager::Link.Bandwidth" - }, - "Description": { - "type": "string" - }, - "GlobalNetworkId": { - "type": "string" - }, - "Provider": { - "type": "string" - }, - "SiteId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Bandwidth", - "GlobalNetworkId", - "SiteId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::Link" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkManager::Link.Bandwidth": { - "additionalProperties": false, - "properties": { - "DownloadSpeed": { - "type": "number" - }, - "UploadSpeed": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::NetworkManager::LinkAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeviceId": { - "type": "string" - }, - "GlobalNetworkId": { - "type": "string" - }, - "LinkId": { - "type": "string" - } - }, - "required": [ - "DeviceId", - "GlobalNetworkId", - "LinkId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::LinkAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkManager::Site": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GlobalNetworkId": { - "type": "string" - }, - "Location": { - "$ref": "#/definitions/AWS::NetworkManager::Site.Location" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "GlobalNetworkId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::Site" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::NetworkManager::Site.Location": { - "additionalProperties": false, - "properties": { - "Address": { - "type": "string" - }, - "Latitude": { - "type": "string" - }, - "Longitude": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::NetworkManager::TransitGatewayRegistration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GlobalNetworkId": { - "type": "string" - }, - "TransitGatewayArn": { - "type": "string" - } - }, - "required": [ - "GlobalNetworkId", - "TransitGatewayArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::NetworkManager::TransitGatewayRegistration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::App": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppSource": { - "$ref": "#/definitions/AWS::OpsWorks::App.Source" - }, - "Attributes": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "DataSources": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::App.DataSource" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "Domains": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EnableSsl": { - "type": "boolean" - }, - "Environment": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::App.EnvironmentVariable" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Shortname": { - "type": "string" - }, - "SslConfiguration": { - "$ref": "#/definitions/AWS::OpsWorks::App.SslConfiguration" - }, - "StackId": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Name", - "StackId", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::App" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::App.DataSource": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::App.EnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Secure": { - "type": "boolean" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::OpsWorks::App.Source": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Revision": { - "type": "string" - }, - "SshKey": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::App.SslConfiguration": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "Chain": { - "type": "string" - }, - "PrivateKey": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::ElasticLoadBalancerAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ElasticLoadBalancerName": { - "type": "string" - }, - "LayerId": { - "type": "string" - } - }, - "required": [ - "ElasticLoadBalancerName", - "LayerId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::ElasticLoadBalancerAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::Instance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AgentVersion": { - "type": "string" - }, - "AmiId": { - "type": "string" - }, - "Architecture": { - "type": "string" - }, - "AutoScalingType": { - "type": "string" - }, - "AvailabilityZone": { - "type": "string" - }, - "BlockDeviceMappings": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::Instance.BlockDeviceMapping" - }, - "type": "array" - }, - "EbsOptimized": { - "type": "boolean" - }, - "ElasticIps": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Hostname": { - "type": "string" - }, - "InstallUpdatesOnBoot": { - "type": "boolean" - }, - "InstanceType": { - "type": "string" - }, - "LayerIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Os": { - "type": "string" - }, - "RootDeviceType": { - "type": "string" - }, - "SshKeyName": { - "type": "string" - }, - "StackId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - }, - "Tenancy": { - "type": "string" - }, - "TimeBasedAutoScaling": { - "$ref": "#/definitions/AWS::OpsWorks::Instance.TimeBasedAutoScaling" - }, - "VirtualizationType": { - "type": "string" - }, - "Volumes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "InstanceType", - "LayerIds", - "StackId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::Instance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::Instance.BlockDeviceMapping": { - "additionalProperties": false, - "properties": { - "DeviceName": { - "type": "string" - }, - "Ebs": { - "$ref": "#/definitions/AWS::OpsWorks::Instance.EbsBlockDevice" - }, - "NoDevice": { - "type": "string" - }, - "VirtualName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Instance.EbsBlockDevice": { - "additionalProperties": false, - "properties": { - "DeleteOnTermination": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "SnapshotId": { - "type": "string" - }, - "VolumeSize": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Instance.TimeBasedAutoScaling": { - "additionalProperties": false, - "properties": { - "Friday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Monday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Saturday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Sunday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Thursday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Tuesday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Wednesday": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Attributes": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "AutoAssignElasticIps": { - "type": "boolean" - }, - "AutoAssignPublicIps": { - "type": "boolean" - }, - "CustomInstanceProfileArn": { - "type": "string" - }, - "CustomJson": { - "type": "object" - }, - "CustomRecipes": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.Recipes" - }, - "CustomSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EnableAutoHealing": { - "type": "boolean" - }, - "InstallUpdatesOnBoot": { - "type": "boolean" - }, - "LifecycleEventConfiguration": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.LifecycleEventConfiguration" - }, - "LoadBasedAutoScaling": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.LoadBasedAutoScaling" - }, - "Name": { - "type": "string" - }, - "Packages": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Shortname": { - "type": "string" - }, - "StackId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - }, - "UseEbsOptimizedInstances": { - "type": "boolean" - }, - "VolumeConfigurations": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.VolumeConfiguration" - }, - "type": "array" - } - }, - "required": [ - "AutoAssignElasticIps", - "AutoAssignPublicIps", - "EnableAutoHealing", - "Name", - "Shortname", - "StackId", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::Layer" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::Layer.AutoScalingThresholds": { - "additionalProperties": false, - "properties": { - "CpuThreshold": { - "type": "number" - }, - "IgnoreMetricsTime": { - "type": "number" - }, - "InstanceCount": { - "type": "number" - }, - "LoadThreshold": { - "type": "number" - }, - "MemoryThreshold": { - "type": "number" - }, - "ThresholdsWaitTime": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer.LifecycleEventConfiguration": { - "additionalProperties": false, - "properties": { - "ShutdownEventConfiguration": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.ShutdownEventConfiguration" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer.LoadBasedAutoScaling": { - "additionalProperties": false, - "properties": { - "DownScaling": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.AutoScalingThresholds" - }, - "Enable": { - "type": "boolean" - }, - "UpScaling": { - "$ref": "#/definitions/AWS::OpsWorks::Layer.AutoScalingThresholds" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer.Recipes": { - "additionalProperties": false, - "properties": { - "Configure": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Deploy": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Setup": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Shutdown": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Undeploy": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer.ShutdownEventConfiguration": { - "additionalProperties": false, - "properties": { - "DelayUntilElbConnectionsDrained": { - "type": "boolean" - }, - "ExecutionTimeout": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Layer.VolumeConfiguration": { - "additionalProperties": false, - "properties": { - "Encrypted": { - "type": "boolean" - }, - "Iops": { - "type": "number" - }, - "MountPoint": { - "type": "string" - }, - "NumberOfDisks": { - "type": "number" - }, - "RaidLevel": { - "type": "number" - }, - "Size": { - "type": "number" - }, - "VolumeType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Stack": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AgentVersion": { - "type": "string" - }, - "Attributes": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "ChefConfiguration": { - "$ref": "#/definitions/AWS::OpsWorks::Stack.ChefConfiguration" - }, - "CloneAppIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClonePermissions": { - "type": "boolean" - }, - "ConfigurationManager": { - "$ref": "#/definitions/AWS::OpsWorks::Stack.StackConfigurationManager" - }, - "CustomCookbooksSource": { - "$ref": "#/definitions/AWS::OpsWorks::Stack.Source" - }, - "CustomJson": { - "type": "object" - }, - "DefaultAvailabilityZone": { - "type": "string" - }, - "DefaultInstanceProfileArn": { - "type": "string" - }, - "DefaultOs": { - "type": "string" - }, - "DefaultRootDeviceType": { - "type": "string" - }, - "DefaultSshKeyName": { - "type": "string" - }, - "DefaultSubnetId": { - "type": "string" - }, - "EcsClusterArn": { - "type": "string" - }, - "ElasticIps": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::Stack.ElasticIp" - }, - "type": "array" - }, - "HostnameTheme": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RdsDbInstances": { - "items": { - "$ref": "#/definitions/AWS::OpsWorks::Stack.RdsDbInstance" - }, - "type": "array" - }, - "ServiceRoleArn": { - "type": "string" - }, - "SourceStackId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UseCustomCookbooks": { - "type": "boolean" - }, - "UseOpsworksSecurityGroups": { - "type": "boolean" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "DefaultInstanceProfileArn", - "Name", - "ServiceRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::Stack" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::Stack.ChefConfiguration": { - "additionalProperties": false, - "properties": { - "BerkshelfVersion": { - "type": "string" - }, - "ManageBerkshelf": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Stack.ElasticIp": { - "additionalProperties": false, - "properties": { - "Ip": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Ip" - ], - "type": "object" - }, - "AWS::OpsWorks::Stack.RdsDbInstance": { - "additionalProperties": false, - "properties": { - "DbPassword": { - "type": "string" - }, - "DbUser": { - "type": "string" - }, - "RdsDbInstanceArn": { - "type": "string" - } - }, - "required": [ - "DbPassword", - "DbUser", - "RdsDbInstanceArn" - ], - "type": "object" - }, - "AWS::OpsWorks::Stack.Source": { - "additionalProperties": false, - "properties": { - "Password": { - "type": "string" - }, - "Revision": { - "type": "string" - }, - "SshKey": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Url": { - "type": "string" - }, - "Username": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::Stack.StackConfigurationManager": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::OpsWorks::UserProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowSelfManagement": { - "type": "boolean" - }, - "IamUserArn": { - "type": "string" - }, - "SshPublicKey": { - "type": "string" - }, - "SshUsername": { - "type": "string" - } - }, - "required": [ - "IamUserArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::UserProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorks::Volume": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Ec2VolumeId": { - "type": "string" - }, - "MountPoint": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "StackId": { - "type": "string" - } - }, - "required": [ - "Ec2VolumeId", - "StackId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorks::Volume" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorksCM::Server": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssociatePublicIpAddress": { - "type": "boolean" - }, - "BackupId": { - "type": "string" - }, - "BackupRetentionCount": { - "type": "number" - }, - "CustomCertificate": { - "type": "string" - }, - "CustomDomain": { - "type": "string" - }, - "CustomPrivateKey": { - "type": "string" - }, - "DisableAutomatedBackup": { - "type": "boolean" - }, - "Engine": { - "type": "string" - }, - "EngineAttributes": { - "items": { - "$ref": "#/definitions/AWS::OpsWorksCM::Server.EngineAttribute" - }, - "type": "array" - }, - "EngineModel": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "InstanceProfileArn": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "KeyPair": { - "type": "string" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ServerName": { - "type": "string" - }, - "ServiceRoleArn": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "InstanceProfileArn", - "InstanceType", - "ServiceRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::OpsWorksCM::Server" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::OpsWorksCM::Server.EngineAttribute": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::ADMChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "ApplicationId", - "ClientId", - "ClientSecret" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::ADMChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::APNSChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::APNSChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::APNSSandboxChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::APNSSandboxChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::APNSVoipChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::APNSVoipChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::APNSVoipSandboxChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "BundleId": { - "type": "string" - }, - "Certificate": { - "type": "string" - }, - "DefaultAuthenticationMethod": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "PrivateKey": { - "type": "string" - }, - "TeamId": { - "type": "string" - }, - "TokenKey": { - "type": "string" - }, - "TokenKeyId": { - "type": "string" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::APNSVoipSandboxChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::App": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::App" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::ApplicationSettings": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "CampaignHook": { - "$ref": "#/definitions/AWS::Pinpoint::ApplicationSettings.CampaignHook" - }, - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "Limits": { - "$ref": "#/definitions/AWS::Pinpoint::ApplicationSettings.Limits" - }, - "QuietTime": { - "$ref": "#/definitions/AWS::Pinpoint::ApplicationSettings.QuietTime" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::ApplicationSettings" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::ApplicationSettings.CampaignHook": { - "additionalProperties": false, - "properties": { - "LambdaFunctionName": { - "type": "string" - }, - "Mode": { - "type": "string" - }, - "WebUrl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::ApplicationSettings.Limits": { - "additionalProperties": false, - "properties": { - "Daily": { - "type": "number" - }, - "MaximumDuration": { - "type": "number" - }, - "MessagesPerSecond": { - "type": "number" - }, - "Total": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Pinpoint::ApplicationSettings.QuietTime": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "required": [ - "End", - "Start" - ], - "type": "object" - }, - "AWS::Pinpoint::BaiduChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "SecretKey": { - "type": "string" - } - }, - "required": [ - "ApiKey", - "ApplicationId", - "SecretKey" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::BaiduChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::Campaign": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AdditionalTreatments": { - "items": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.WriteTreatmentResource" - }, - "type": "array" - }, - "ApplicationId": { - "type": "string" - }, - "CampaignHook": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignHook" - }, - "Description": { - "type": "string" - }, - "HoldoutPercent": { - "type": "number" - }, - "IsPaused": { - "type": "boolean" - }, - "Limits": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Limits" - }, - "MessageConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration" - }, - "Name": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Schedule" - }, - "SegmentId": { - "type": "string" - }, - "SegmentVersion": { - "type": "number" - }, - "Tags": { - "type": "object" - }, - "TreatmentDescription": { - "type": "string" - }, - "TreatmentName": { - "type": "string" - } - }, - "required": [ - "ApplicationId", - "MessageConfiguration", - "Name", - "Schedule", - "SegmentId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::Campaign" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::Campaign.AttributeDimension": { - "additionalProperties": false, - "properties": { - "AttributeType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.CampaignEmailMessage": { - "additionalProperties": false, - "properties": { - "Body": { - "type": "string" - }, - "FromAddress": { - "type": "string" - }, - "HtmlBody": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.CampaignEventFilter": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.EventDimensions" - }, - "FilterType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.CampaignHook": { - "additionalProperties": false, - "properties": { - "LambdaFunctionName": { - "type": "string" - }, - "Mode": { - "type": "string" - }, - "WebUrl": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.CampaignSmsMessage": { - "additionalProperties": false, - "properties": { - "Body": { - "type": "string" - }, - "EntityId": { - "type": "string" - }, - "MessageType": { - "type": "string" - }, - "OriginationNumber": { - "type": "string" - }, - "SenderId": { - "type": "string" - }, - "TemplateId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.EventDimensions": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "EventType": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.SetDimension" - }, - "Metrics": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.Limits": { - "additionalProperties": false, - "properties": { - "Daily": { - "type": "number" - }, - "MaximumDuration": { - "type": "number" - }, - "MessagesPerSecond": { - "type": "number" - }, - "Total": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.Message": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "ImageIconUrl": { - "type": "string" - }, - "ImageSmallIconUrl": { - "type": "string" - }, - "ImageUrl": { - "type": "string" - }, - "JsonBody": { - "type": "string" - }, - "MediaUrl": { - "type": "string" - }, - "RawContent": { - "type": "string" - }, - "SilentPush": { - "type": "boolean" - }, - "TimeToLive": { - "type": "number" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.MessageConfiguration": { - "additionalProperties": false, - "properties": { - "ADMMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message" - }, - "APNSMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message" - }, - "BaiduMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message" - }, - "DefaultMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message" - }, - "EmailMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignEmailMessage" - }, - "GCMMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message" - }, - "SMSMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignSmsMessage" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.MetricDimension": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.QuietTime": { - "additionalProperties": false, - "properties": { - "End": { - "type": "string" - }, - "Start": { - "type": "string" - } - }, - "required": [ - "End", - "Start" - ], - "type": "object" - }, - "AWS::Pinpoint::Campaign.Schedule": { - "additionalProperties": false, - "properties": { - "EndTime": { - "type": "string" - }, - "EventFilter": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignEventFilter" - }, - "Frequency": { - "type": "string" - }, - "IsLocalTime": { - "type": "boolean" - }, - "QuietTime": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.QuietTime" - }, - "StartTime": { - "type": "string" - }, - "TimeZone": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.SetDimension": { - "additionalProperties": false, - "properties": { - "DimensionType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Campaign.WriteTreatmentResource": { - "additionalProperties": false, - "properties": { - "MessageConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration" - }, - "Schedule": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Schedule" - }, - "SizePercent": { - "type": "number" - }, - "TreatmentDescription": { - "type": "string" - }, - "TreatmentName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::EmailChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "ConfigurationSet": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "FromAddress": { - "type": "string" - }, - "Identity": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "ApplicationId", - "FromAddress", - "Identity" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::EmailChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::EmailTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultSubstitutions": { - "type": "string" - }, - "HtmlPart": { - "type": "string" - }, - "Subject": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - }, - "TextPart": { - "type": "string" - } - }, - "required": [ - "Subject", - "TemplateName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::EmailTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::EventStream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "DestinationStreamArn": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "ApplicationId", - "DestinationStreamArn", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::EventStream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::GCMChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApiKey": { - "type": "string" - }, - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "ApiKey", - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::GCMChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::PushTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ADM": { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate" - }, - "APNS": { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate.APNSPushNotificationTemplate" - }, - "Baidu": { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate" - }, - "Default": { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate.DefaultPushNotificationTemplate" - }, - "DefaultSubstitutions": { - "type": "string" - }, - "GCM": { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "required": [ - "TemplateName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::PushTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::PushTemplate.APNSPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "MediaUrl": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::PushTemplate.AndroidPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "ImageIconUrl": { - "type": "string" - }, - "ImageUrl": { - "type": "string" - }, - "SmallImageIconUrl": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::PushTemplate.DefaultPushNotificationTemplate": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Body": { - "type": "string" - }, - "Sound": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::SMSChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - }, - "SenderId": { - "type": "string" - }, - "ShortCode": { - "type": "string" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::SMSChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::Segment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "Dimensions": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SegmentDimensions" - }, - "Name": { - "type": "string" - }, - "SegmentGroups": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SegmentGroups" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "ApplicationId", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::Segment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::Segment.AttributeDimension": { - "additionalProperties": false, - "properties": { - "AttributeType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.Behavior": { - "additionalProperties": false, - "properties": { - "Recency": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Recency" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.Coordinates": { - "additionalProperties": false, - "properties": { - "Latitude": { - "type": "number" - }, - "Longitude": { - "type": "number" - } - }, - "required": [ - "Latitude", - "Longitude" - ], - "type": "object" - }, - "AWS::Pinpoint::Segment.Demographic": { - "additionalProperties": false, - "properties": { - "AppVersion": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "Channel": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "DeviceType": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "Make": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "Model": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "Platform": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.GPSPoint": { - "additionalProperties": false, - "properties": { - "Coordinates": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Coordinates" - }, - "RangeInKilometers": { - "type": "number" - } - }, - "required": [ - "Coordinates", - "RangeInKilometers" - ], - "type": "object" - }, - "AWS::Pinpoint::Segment.Groups": { - "additionalProperties": false, - "properties": { - "Dimensions": { - "items": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SegmentDimensions" - }, - "type": "array" - }, - "SourceSegments": { - "items": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SourceSegments" - }, - "type": "array" - }, - "SourceType": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.Location": { - "additionalProperties": false, - "properties": { - "Country": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.SetDimension" - }, - "GPSPoint": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.GPSPoint" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.Recency": { - "additionalProperties": false, - "properties": { - "Duration": { - "type": "string" - }, - "RecencyType": { - "type": "string" - } - }, - "required": [ - "Duration", - "RecencyType" - ], - "type": "object" - }, - "AWS::Pinpoint::Segment.SegmentDimensions": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "Behavior": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Behavior" - }, - "Demographic": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Demographic" - }, - "Location": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Location" - }, - "Metrics": { - "type": "object" - }, - "UserAttributes": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.SegmentGroups": { - "additionalProperties": false, - "properties": { - "Groups": { - "items": { - "$ref": "#/definitions/AWS::Pinpoint::Segment.Groups" - }, - "type": "array" - }, - "Include": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.SetDimension": { - "additionalProperties": false, - "properties": { - "DimensionType": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::Pinpoint::Segment.SourceSegments": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Version": { - "type": "number" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "AWS::Pinpoint::SmsTemplate": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Body": { - "type": "string" - }, - "DefaultSubstitutions": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "TemplateDescription": { - "type": "string" - }, - "TemplateName": { - "type": "string" - } - }, - "required": [ - "Body", - "TemplateName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::SmsTemplate" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Pinpoint::VoiceChannel": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplicationId": { - "type": "string" - }, - "Enabled": { - "type": "boolean" - } - }, - "required": [ - "ApplicationId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Pinpoint::VoiceChannel" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeliveryOptions": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet.DeliveryOptions" - }, - "Name": { - "type": "string" - }, - "ReputationOptions": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet.ReputationOptions" - }, - "SendingOptions": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet.SendingOptions" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet.Tags" - }, - "type": "array" - }, - "TrackingOptions": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet.TrackingOptions" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::PinpointEmail::ConfigurationSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet.DeliveryOptions": { - "additionalProperties": false, - "properties": { - "SendingPoolName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet.ReputationOptions": { - "additionalProperties": false, - "properties": { - "ReputationMetricsEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet.SendingOptions": { - "additionalProperties": false, - "properties": { - "SendingEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSet.TrackingOptions": { - "additionalProperties": false, - "properties": { - "CustomRedirectDomain": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConfigurationSetName": { - "type": "string" - }, - "EventDestination": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.EventDestination" - }, - "EventDestinationName": { - "type": "string" - } - }, - "required": [ - "ConfigurationSetName", - "EventDestinationName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::PinpointEmail::ConfigurationSetEventDestination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.CloudWatchDestination": { - "additionalProperties": false, - "properties": { - "DimensionConfigurations": { - "items": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.DimensionConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.DimensionConfiguration": { - "additionalProperties": false, - "properties": { - "DefaultDimensionValue": { - "type": "string" - }, - "DimensionName": { - "type": "string" - }, - "DimensionValueSource": { - "type": "string" - } - }, - "required": [ - "DefaultDimensionValue", - "DimensionName", - "DimensionValueSource" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.EventDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchDestination": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.CloudWatchDestination" - }, - "Enabled": { - "type": "boolean" - }, - "KinesisFirehoseDestination": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.KinesisFirehoseDestination" - }, - "MatchingEventTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PinpointDestination": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.PinpointDestination" - }, - "SnsDestination": { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination.SnsDestination" - } - }, - "required": [ - "MatchingEventTypes" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.KinesisFirehoseDestination": { - "additionalProperties": false, - "properties": { - "DeliveryStreamArn": { - "type": "string" - }, - "IamRoleArn": { - "type": "string" - } - }, - "required": [ - "DeliveryStreamArn", - "IamRoleArn" - ], - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.PinpointDestination": { - "additionalProperties": false, - "properties": { - "ApplicationArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::ConfigurationSetEventDestination.SnsDestination": { - "additionalProperties": false, - "properties": { - "TopicArn": { - "type": "string" - } - }, - "required": [ - "TopicArn" - ], - "type": "object" - }, - "AWS::PinpointEmail::DedicatedIpPool": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PoolName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::PinpointEmail::DedicatedIpPool.Tags" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::PinpointEmail::DedicatedIpPool" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::PinpointEmail::DedicatedIpPool.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::Identity": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DkimSigningEnabled": { - "type": "boolean" - }, - "FeedbackForwardingEnabled": { - "type": "boolean" - }, - "MailFromAttributes": { - "$ref": "#/definitions/AWS::PinpointEmail::Identity.MailFromAttributes" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::PinpointEmail::Identity.Tags" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::PinpointEmail::Identity" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::PinpointEmail::Identity.MailFromAttributes": { - "additionalProperties": false, - "properties": { - "BehaviorOnMxFailure": { - "type": "string" - }, - "MailFromDomain": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::PinpointEmail::Identity.Tags": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QLDB::Ledger": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeletionProtection": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "PermissionsMode": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PermissionsMode" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QLDB::Ledger" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QLDB::Stream": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ExclusiveEndTime": { - "type": "string" - }, - "InclusiveStartTime": { - "type": "string" - }, - "KinesisConfiguration": { - "$ref": "#/definitions/AWS::QLDB::Stream.KinesisConfiguration" - }, - "LedgerName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "StreamName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "InclusiveStartTime", - "KinesisConfiguration", - "LedgerName", - "RoleArn", - "StreamName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QLDB::Stream" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QLDB::Stream.KinesisConfiguration": { - "additionalProperties": false, - "properties": { - "AggregationEnabled": { - "type": "boolean" - }, - "StreamArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Analysis": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AnalysisId": { - "type": "string" - }, - "AwsAccountId": { - "type": "string" - }, - "Errors": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisError" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.Parameters" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.ResourcePermission" - }, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisSourceEntity" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThemeArn": { - "type": "string" - } - }, - "required": [ - "AnalysisId", - "AwsAccountId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QuickSight::Analysis" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.AnalysisError": { - "additionalProperties": false, - "properties": { - "Message": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Analysis.AnalysisSourceEntity": { - "additionalProperties": false, - "properties": { - "SourceTemplate": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisSourceTemplate" - } - }, - "type": "object" - }, - "AWS::QuickSight::Analysis.AnalysisSourceTemplate": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "DataSetReferences": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.DataSetReference" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.DataSetReference": { - "additionalProperties": false, - "properties": { - "DataSetArn": { - "type": "string" - }, - "DataSetPlaceholder": { - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.DateTimeParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.DecimalParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.IntegerParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.Parameters": { - "additionalProperties": false, - "properties": { - "DateTimeParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.DateTimeParameter" - }, - "type": "array" - }, - "DecimalParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.DecimalParameter" - }, - "type": "array" - }, - "IntegerParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.IntegerParameter" - }, - "type": "array" - }, - "StringParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Analysis.StringParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::QuickSight::Analysis.ResourcePermission": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "AWS::QuickSight::Analysis.Sheet": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SheetId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Analysis.StringParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "type": "string" - }, - "DashboardId": { - "type": "string" - }, - "DashboardPublishOptions": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DashboardPublishOptions" - }, - "Name": { - "type": "string" - }, - "Parameters": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.Parameters" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.ResourcePermission" - }, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DashboardSourceEntity" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThemeArn": { - "type": "string" - }, - "VersionDescription": { - "type": "string" - } - }, - "required": [ - "AwsAccountId", - "DashboardId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QuickSight::Dashboard" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.AdHocFilteringOption": { - "additionalProperties": false, - "properties": { - "AvailabilityStatus": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.DashboardPublishOptions": { - "additionalProperties": false, - "properties": { - "AdHocFilteringOption": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.AdHocFilteringOption" - }, - "ExportToCSVOption": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.ExportToCSVOption" - }, - "SheetControlsOption": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.SheetControlsOption" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.DashboardSourceEntity": { - "additionalProperties": false, - "properties": { - "SourceTemplate": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DashboardSourceTemplate" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.DashboardSourceTemplate": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "DataSetReferences": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DataSetReference" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.DataSetReference": { - "additionalProperties": false, - "properties": { - "DataSetArn": { - "type": "string" - }, - "DataSetPlaceholder": { - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.DateTimeParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.DecimalParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.ExportToCSVOption": { - "additionalProperties": false, - "properties": { - "AvailabilityStatus": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.IntegerParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.Parameters": { - "additionalProperties": false, - "properties": { - "DateTimeParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DateTimeParameter" - }, - "type": "array" - }, - "DecimalParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.DecimalParameter" - }, - "type": "array" - }, - "IntegerParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.IntegerParameter" - }, - "type": "array" - }, - "StringParameters": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Dashboard.StringParameter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.ResourcePermission": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "AWS::QuickSight::Dashboard.SheetControlsOption": { - "additionalProperties": false, - "properties": { - "VisibilityState": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Dashboard.StringParameter": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Values" - ], - "type": "object" - }, - "AWS::QuickSight::Template": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Template.ResourcePermission" - }, - "type": "array" - }, - "SourceEntity": { - "$ref": "#/definitions/AWS::QuickSight::Template.TemplateSourceEntity" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TemplateId": { - "type": "string" - }, - "VersionDescription": { - "type": "string" - } - }, - "required": [ - "AwsAccountId", - "TemplateId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QuickSight::Template" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QuickSight::Template.DataSetReference": { - "additionalProperties": false, - "properties": { - "DataSetArn": { - "type": "string" - }, - "DataSetPlaceholder": { - "type": "string" - } - }, - "required": [ - "DataSetArn", - "DataSetPlaceholder" - ], - "type": "object" - }, - "AWS::QuickSight::Template.ResourcePermission": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "AWS::QuickSight::Template.TemplateSourceAnalysis": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "DataSetReferences": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Template.DataSetReference" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "DataSetReferences" - ], - "type": "object" - }, - "AWS::QuickSight::Template.TemplateSourceEntity": { - "additionalProperties": false, - "properties": { - "SourceAnalysis": { - "$ref": "#/definitions/AWS::QuickSight::Template.TemplateSourceAnalysis" - }, - "SourceTemplate": { - "$ref": "#/definitions/AWS::QuickSight::Template.TemplateSourceTemplate" - } - }, - "type": "object" - }, - "AWS::QuickSight::Template.TemplateSourceTemplate": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::QuickSight::Theme": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AwsAccountId": { - "type": "string" - }, - "BaseThemeId": { - "type": "string" - }, - "Configuration": { - "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeConfiguration" - }, - "Name": { - "type": "string" - }, - "Permissions": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Theme.ResourcePermission" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "ThemeId": { - "type": "string" - }, - "VersionDescription": { - "type": "string" - } - }, - "required": [ - "AwsAccountId", - "ThemeId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::QuickSight::Theme" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::QuickSight::Theme.BorderStyle": { - "additionalProperties": false, - "properties": { - "Show": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.DataColorPalette": { - "additionalProperties": false, - "properties": { - "Colors": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EmptyFillColor": { - "type": "string" - }, - "MinMaxGradient": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.Font": { - "additionalProperties": false, - "properties": { - "FontFamily": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.GutterStyle": { - "additionalProperties": false, - "properties": { - "Show": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.MarginStyle": { - "additionalProperties": false, - "properties": { - "Show": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.ResourcePermission": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Principal": { - "type": "string" - } - }, - "required": [ - "Actions", - "Principal" - ], - "type": "object" - }, - "AWS::QuickSight::Theme.SheetStyle": { - "additionalProperties": false, - "properties": { - "Tile": { - "$ref": "#/definitions/AWS::QuickSight::Theme.TileStyle" - }, - "TileLayout": { - "$ref": "#/definitions/AWS::QuickSight::Theme.TileLayoutStyle" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.ThemeConfiguration": { - "additionalProperties": false, - "properties": { - "DataColorPalette": { - "$ref": "#/definitions/AWS::QuickSight::Theme.DataColorPalette" - }, - "Sheet": { - "$ref": "#/definitions/AWS::QuickSight::Theme.SheetStyle" - }, - "Typography": { - "$ref": "#/definitions/AWS::QuickSight::Theme.Typography" - }, - "UIColorPalette": { - "$ref": "#/definitions/AWS::QuickSight::Theme.UIColorPalette" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.TileLayoutStyle": { - "additionalProperties": false, - "properties": { - "Gutter": { - "$ref": "#/definitions/AWS::QuickSight::Theme.GutterStyle" - }, - "Margin": { - "$ref": "#/definitions/AWS::QuickSight::Theme.MarginStyle" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.TileStyle": { - "additionalProperties": false, - "properties": { - "Border": { - "$ref": "#/definitions/AWS::QuickSight::Theme.BorderStyle" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.Typography": { - "additionalProperties": false, - "properties": { - "FontFamilies": { - "items": { - "$ref": "#/definitions/AWS::QuickSight::Theme.Font" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::QuickSight::Theme.UIColorPalette": { - "additionalProperties": false, - "properties": { - "Accent": { - "type": "string" - }, - "AccentForeground": { - "type": "string" - }, - "Danger": { - "type": "string" - }, - "DangerForeground": { - "type": "string" - }, - "Dimension": { - "type": "string" - }, - "DimensionForeground": { - "type": "string" - }, - "Measure": { - "type": "string" - }, - "MeasureForeground": { - "type": "string" - }, - "PrimaryBackground": { - "type": "string" - }, - "PrimaryForeground": { - "type": "string" - }, - "SecondaryBackground": { - "type": "string" - }, - "SecondaryForeground": { - "type": "string" - }, - "Success": { - "type": "string" - }, - "SuccessForeground": { - "type": "string" - }, - "Warning": { - "type": "string" - }, - "WarningForeground": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RAM::ResourceShare": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowExternalPrincipals": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Principals": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ResourceArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RAM::ResourceShare" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AssociatedRoles": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBCluster.DBClusterRole" - }, - "type": "array" - }, - "AvailabilityZones": { - "items": { - "type": "string" - }, - "type": "array" - }, - "BacktrackWindow": { - "type": "number" - }, - "BackupRetentionPeriod": { - "type": "number" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBClusterParameterGroupName": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "DeletionProtection": { - "type": "boolean" - }, - "EnableCloudwatchLogsExports": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EnableHttpEndpoint": { - "type": "boolean" - }, - "EnableIAMDatabaseAuthentication": { - "type": "boolean" - }, - "Engine": { - "type": "string" - }, - "EngineMode": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "GlobalClusterIdentifier": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - }, - "MasterUsername": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ReplicationSourceIdentifier": { - "type": "string" - }, - "RestoreType": { - "type": "string" - }, - "ScalingConfiguration": { - "$ref": "#/definitions/AWS::RDS::DBCluster.ScalingConfiguration" - }, - "SnapshotIdentifier": { - "type": "string" - }, - "SourceDBClusterIdentifier": { - "type": "string" - }, - "SourceRegion": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UseLatestRestorableTime": { - "type": "boolean" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Engine" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBCluster.DBClusterRole": { - "additionalProperties": false, - "properties": { - "FeatureName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "AWS::RDS::DBCluster.ScalingConfiguration": { - "additionalProperties": false, - "properties": { - "AutoPause": { - "type": "boolean" - }, - "MaxCapacity": { - "type": "number" - }, - "MinCapacity": { - "type": "number" - }, - "SecondsUntilAutoPause": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::RDS::DBClusterParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "Family", - "Parameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBClusterParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBInstance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllocatedStorage": { - "type": "string" - }, - "AllowMajorVersionUpgrade": { - "type": "boolean" - }, - "AssociatedRoles": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBInstance.DBInstanceRole" - }, - "type": "array" - }, - "AutoMinorVersionUpgrade": { - "type": "boolean" - }, - "AvailabilityZone": { - "type": "string" - }, - "BackupRetentionPeriod": { - "type": "number" - }, - "CACertificateIdentifier": { - "type": "string" - }, - "CharacterSetName": { - "type": "string" - }, - "CopyTagsToSnapshot": { - "type": "boolean" - }, - "DBClusterIdentifier": { - "type": "string" - }, - "DBInstanceClass": { - "type": "string" - }, - "DBInstanceIdentifier": { - "type": "string" - }, - "DBName": { - "type": "string" - }, - "DBParameterGroupName": { - "type": "string" - }, - "DBSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DBSnapshotIdentifier": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "DeleteAutomatedBackups": { - "type": "boolean" - }, - "DeletionProtection": { - "type": "boolean" - }, - "Domain": { - "type": "string" - }, - "DomainIAMRoleName": { - "type": "string" - }, - "EnableCloudwatchLogsExports": { - "items": { - "type": "string" - }, - "type": "array" - }, - "EnableIAMDatabaseAuthentication": { - "type": "boolean" - }, - "EnablePerformanceInsights": { - "type": "boolean" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "Iops": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - }, - "LicenseModel": { - "type": "string" - }, - "MasterUserPassword": { - "type": "string" - }, - "MasterUsername": { - "type": "string" - }, - "MaxAllocatedStorage": { - "type": "number" - }, - "MonitoringInterval": { - "type": "number" - }, - "MonitoringRoleArn": { - "type": "string" - }, - "MultiAZ": { - "type": "boolean" - }, - "OptionGroupName": { - "type": "string" - }, - "PerformanceInsightsKMSKeyId": { - "type": "string" - }, - "PerformanceInsightsRetentionPeriod": { - "type": "number" - }, - "Port": { - "type": "string" - }, - "PreferredBackupWindow": { - "type": "string" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "ProcessorFeatures": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBInstance.ProcessorFeature" - }, - "type": "array" - }, - "PromotionTier": { - "type": "number" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "SourceDBInstanceIdentifier": { - "type": "string" - }, - "SourceRegion": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - }, - "StorageType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Timezone": { - "type": "string" - }, - "UseDefaultProcessorFeatures": { - "type": "boolean" - }, - "VPCSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "DBInstanceClass" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBInstance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBInstance.DBInstanceRole": { - "additionalProperties": false, - "properties": { - "FeatureName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "FeatureName", - "RoleArn" - ], - "type": "object" - }, - "AWS::RDS::DBInstance.ProcessorFeature": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RDS::DBParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Family": { - "type": "string" - }, - "Parameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "Family" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBProxy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Auth": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBProxy.AuthFormat" - }, - "type": "array" - }, - "DBProxyName": { - "type": "string" - }, - "DebugLogging": { - "type": "boolean" - }, - "EngineFamily": { - "type": "string" - }, - "IdleClientTimeout": { - "type": "number" - }, - "RequireTLS": { - "type": "boolean" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBProxy.TagFormat" - }, - "type": "array" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcSubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Auth", - "DBProxyName", - "EngineFamily", - "RoleArn", - "VpcSubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBProxy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBProxy.AuthFormat": { - "additionalProperties": false, - "properties": { - "AuthScheme": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "IAMAuth": { - "type": "string" - }, - "SecretArn": { - "type": "string" - }, - "UserName": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RDS::DBProxy.TagFormat": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RDS::DBProxyEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DBProxyEndpointName": { - "type": "string" - }, - "DBProxyName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBProxyEndpoint.TagFormat" - }, - "type": "array" - }, - "TargetRole": { - "type": "string" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcSubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "DBProxyEndpointName", - "DBProxyName", - "VpcSubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBProxyEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBProxyEndpoint.TagFormat": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RDS::DBProxyTargetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionPoolConfigurationInfo": { - "$ref": "#/definitions/AWS::RDS::DBProxyTargetGroup.ConnectionPoolConfigurationInfoFormat" - }, - "DBClusterIdentifiers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DBInstanceIdentifiers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DBProxyName": { - "type": "string" - }, - "TargetGroupName": { - "type": "string" - } - }, - "required": [ - "DBProxyName", - "TargetGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBProxyTargetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBProxyTargetGroup.ConnectionPoolConfigurationInfoFormat": { - "additionalProperties": false, - "properties": { - "ConnectionBorrowTimeout": { - "type": "number" - }, - "InitQuery": { - "type": "string" - }, - "MaxConnectionsPercent": { - "type": "number" - }, - "MaxIdleConnectionsPercent": { - "type": "number" - }, - "SessionPinningFilters": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::RDS::DBSecurityGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DBSecurityGroupIngress": { - "items": { - "$ref": "#/definitions/AWS::RDS::DBSecurityGroup.Ingress" - }, - "type": "array" - }, - "EC2VpcId": { - "type": "string" - }, - "GroupDescription": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBSecurityGroupIngress", - "GroupDescription" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBSecurityGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBSecurityGroup.Ingress": { - "additionalProperties": false, - "properties": { - "CIDRIP": { - "type": "string" - }, - "EC2SecurityGroupId": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::RDS::DBSecurityGroupIngress": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CIDRIP": { - "type": "string" - }, - "DBSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupId": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - } - }, - "required": [ - "DBSecurityGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBSecurityGroupIngress" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::DBSubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DBSubnetGroupDescription": { - "type": "string" - }, - "DBSubnetGroupName": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DBSubnetGroupDescription", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::DBSubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::EventSubscription": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - }, - "EventCategories": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SnsTopicArn": { - "type": "string" - }, - "SourceIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceType": { - "type": "string" - } - }, - "required": [ - "SnsTopicArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::EventSubscription" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::GlobalCluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeletionProtection": { - "type": "boolean" - }, - "Engine": { - "type": "string" - }, - "EngineVersion": { - "type": "string" - }, - "GlobalClusterIdentifier": { - "type": "string" - }, - "SourceDBClusterIdentifier": { - "type": "string" - }, - "StorageEncrypted": { - "type": "boolean" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::GlobalCluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::RDS::OptionGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EngineName": { - "type": "string" - }, - "MajorEngineVersion": { - "type": "string" - }, - "OptionConfigurations": { - "items": { - "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionConfiguration" - }, - "type": "array" - }, - "OptionGroupDescription": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "EngineName", - "MajorEngineVersion", - "OptionConfigurations", - "OptionGroupDescription" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RDS::OptionGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RDS::OptionGroup.OptionConfiguration": { - "additionalProperties": false, - "properties": { - "DBSecurityGroupMemberships": { - "items": { - "type": "string" - }, - "type": "array" - }, - "OptionName": { - "type": "string" - }, - "OptionSettings": { - "items": { - "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionSetting" - }, - "type": "array" - }, - "OptionVersion": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "VpcSecurityGroupMemberships": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "OptionName" - ], - "type": "object" - }, - "AWS::RDS::OptionGroup.OptionSetting": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Redshift::Cluster": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowVersionUpgrade": { - "type": "boolean" - }, - "AutomatedSnapshotRetentionPeriod": { - "type": "number" - }, - "AvailabilityZone": { - "type": "string" - }, - "ClusterIdentifier": { - "type": "string" - }, - "ClusterParameterGroupName": { - "type": "string" - }, - "ClusterSecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ClusterSubnetGroupName": { - "type": "string" - }, - "ClusterType": { - "type": "string" - }, - "ClusterVersion": { - "type": "string" - }, - "DBName": { - "type": "string" - }, - "ElasticIp": { - "type": "string" - }, - "Encrypted": { - "type": "boolean" - }, - "HsmClientCertificateIdentifier": { - "type": "string" - }, - "HsmConfigurationIdentifier": { - "type": "string" - }, - "IamRoles": { - "items": { - "type": "string" - }, - "type": "array" - }, - "KmsKeyId": { - "type": "string" - }, - "LoggingProperties": { - "$ref": "#/definitions/AWS::Redshift::Cluster.LoggingProperties" - }, - "MasterUserPassword": { - "type": "string" - }, - "MasterUsername": { - "type": "string" - }, - "NodeType": { - "type": "string" - }, - "NumberOfNodes": { - "type": "number" - }, - "OwnerAccount": { - "type": "string" - }, - "Port": { - "type": "number" - }, - "PreferredMaintenanceWindow": { - "type": "string" - }, - "PubliclyAccessible": { - "type": "boolean" - }, - "SnapshotClusterIdentifier": { - "type": "string" - }, - "SnapshotIdentifier": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcSecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "ClusterType", - "DBName", - "MasterUserPassword", - "MasterUsername", - "NodeType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Redshift::Cluster" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Redshift::Cluster.LoggingProperties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "S3KeyPrefix": { - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "AWS::Redshift::ClusterParameterGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "ParameterGroupFamily": { - "type": "string" - }, - "Parameters": { - "items": { - "$ref": "#/definitions/AWS::Redshift::ClusterParameterGroup.Parameter" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "ParameterGroupFamily" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Redshift::ClusterParameterGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Redshift::ClusterParameterGroup.Parameter": { - "additionalProperties": false, - "properties": { - "ParameterName": { - "type": "string" - }, - "ParameterValue": { - "type": "string" - } - }, - "required": [ - "ParameterName", - "ParameterValue" - ], - "type": "object" - }, - "AWS::Redshift::ClusterSecurityGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Redshift::ClusterSecurityGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Redshift::ClusterSecurityGroupIngress": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CIDRIP": { - "type": "string" - }, - "ClusterSecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupName": { - "type": "string" - }, - "EC2SecurityGroupOwnerId": { - "type": "string" - } - }, - "required": [ - "ClusterSecurityGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Redshift::ClusterSecurityGroupIngress" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Redshift::ClusterSubnetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Description", - "SubnetIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Redshift::ClusterSubnetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ResourceGroups::Group": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResourceQuery": { - "$ref": "#/definitions/AWS::ResourceGroups::Group.ResourceQuery" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ResourceGroups::Group" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ResourceGroups::Group.Query": { - "additionalProperties": false, - "properties": { - "ResourceTypeFilters": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StackIdentifier": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::ResourceGroups::Group.TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ResourceGroups::Group.ResourceQuery": { - "additionalProperties": false, - "properties": { - "Query": { - "$ref": "#/definitions/AWS::ResourceGroups::Group.Query" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::ResourceGroups::Group.TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::RoboMaker::Fleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::Fleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::RoboMaker::Robot": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Architecture": { - "type": "string" - }, - "Fleet": { - "type": "string" - }, - "GreengrassGroupId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "Architecture", - "GreengrassGroupId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::Robot" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RoboMaker::RobotApplication": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CurrentRevisionId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RobotSoftwareSuite": { - "$ref": "#/definitions/AWS::RoboMaker::RobotApplication.RobotSoftwareSuite" - }, - "Sources": { - "items": { - "$ref": "#/definitions/AWS::RoboMaker::RobotApplication.SourceConfig" - }, - "type": "array" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "RobotSoftwareSuite", - "Sources" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::RobotApplication" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RoboMaker::RobotApplication.RobotSoftwareSuite": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Name", - "Version" - ], - "type": "object" - }, - "AWS::RoboMaker::RobotApplication.SourceConfig": { - "additionalProperties": false, - "properties": { - "Architecture": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "Architecture", - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "AWS::RoboMaker::RobotApplicationVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Application": { - "type": "string" - }, - "CurrentRevisionId": { - "type": "string" - } - }, - "required": [ - "Application" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::RobotApplicationVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplication": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CurrentRevisionId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RenderingEngine": { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.RenderingEngine" - }, - "RobotSoftwareSuite": { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite" - }, - "SimulationSoftwareSuite": { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite" - }, - "Sources": { - "items": { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.SourceConfig" - }, - "type": "array" - }, - "Tags": { - "type": "object" - } - }, - "required": [ - "RenderingEngine", - "RobotSoftwareSuite", - "SimulationSoftwareSuite", - "Sources" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::SimulationApplication" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplication.RenderingEngine": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Name", - "Version" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Name", - "Version" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplication.SimulationSoftwareSuite": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Name", - "Version" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplication.SourceConfig": { - "additionalProperties": false, - "properties": { - "Architecture": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - } - }, - "required": [ - "Architecture", - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "AWS::RoboMaker::SimulationApplicationVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Application": { - "type": "string" - }, - "CurrentRevisionId": { - "type": "string" - } - }, - "required": [ - "Application" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::RoboMaker::SimulationApplicationVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::DNSSEC": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HostedZoneId": { - "type": "string" - } - }, - "required": [ - "HostedZoneId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::DNSSEC" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::HealthCheck": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HealthCheckConfig": { - "type": "object" - }, - "HealthCheckTags": { - "items": { - "$ref": "#/definitions/AWS::Route53::HealthCheck.HealthCheckTag" - }, - "type": "array" - } - }, - "required": [ - "HealthCheckConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::HealthCheck" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::HealthCheck.HealthCheckTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::Route53::HostedZone": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HostedZoneConfig": { - "$ref": "#/definitions/AWS::Route53::HostedZone.HostedZoneConfig" - }, - "HostedZoneTags": { - "items": { - "$ref": "#/definitions/AWS::Route53::HostedZone.HostedZoneTag" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "QueryLoggingConfig": { - "$ref": "#/definitions/AWS::Route53::HostedZone.QueryLoggingConfig" - }, - "VPCs": { - "items": { - "$ref": "#/definitions/AWS::Route53::HostedZone.VPC" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::HostedZone" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::HostedZone.HostedZoneConfig": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Route53::HostedZone.HostedZoneTag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::Route53::HostedZone.QueryLoggingConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroupArn": { - "type": "string" - } - }, - "required": [ - "CloudWatchLogsLogGroupArn" - ], - "type": "object" - }, - "AWS::Route53::HostedZone.VPC": { - "additionalProperties": false, - "properties": { - "VPCId": { - "type": "string" - }, - "VPCRegion": { - "type": "string" - } - }, - "required": [ - "VPCId", - "VPCRegion" - ], - "type": "object" - }, - "AWS::Route53::KeySigningKey": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HostedZoneId": { - "type": "string" - }, - "KeyManagementServiceArn": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "HostedZoneId", - "KeyManagementServiceArn", - "Name", - "Status" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::KeySigningKey" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::RecordSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AliasTarget": { - "$ref": "#/definitions/AWS::Route53::RecordSet.AliasTarget" - }, - "Comment": { - "type": "string" - }, - "Failover": { - "type": "string" - }, - "GeoLocation": { - "$ref": "#/definitions/AWS::Route53::RecordSet.GeoLocation" - }, - "HealthCheckId": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "MultiValueAnswer": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceRecords": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SetIdentifier": { - "type": "string" - }, - "TTL": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::RecordSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53::RecordSet.AliasTarget": { - "additionalProperties": false, - "properties": { - "DNSName": { - "type": "string" - }, - "EvaluateTargetHealth": { - "type": "boolean" - }, - "HostedZoneId": { - "type": "string" - } - }, - "required": [ - "DNSName", - "HostedZoneId" - ], - "type": "object" - }, - "AWS::Route53::RecordSet.GeoLocation": { - "additionalProperties": false, - "properties": { - "ContinentCode": { - "type": "string" - }, - "CountryCode": { - "type": "string" - }, - "SubdivisionCode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Route53::RecordSetGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "RecordSets": { - "items": { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup.RecordSet" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53::RecordSetGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Route53::RecordSetGroup.AliasTarget": { - "additionalProperties": false, - "properties": { - "DNSName": { - "type": "string" - }, - "EvaluateTargetHealth": { - "type": "boolean" - }, - "HostedZoneId": { - "type": "string" - } - }, - "required": [ - "DNSName", - "HostedZoneId" - ], - "type": "object" - }, - "AWS::Route53::RecordSetGroup.GeoLocation": { - "additionalProperties": false, - "properties": { - "ContinentCode": { - "type": "string" - }, - "CountryCode": { - "type": "string" - }, - "SubdivisionCode": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Route53::RecordSetGroup.RecordSet": { - "additionalProperties": false, - "properties": { - "AliasTarget": { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup.AliasTarget" - }, - "Comment": { - "type": "string" - }, - "Failover": { - "type": "string" - }, - "GeoLocation": { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup.GeoLocation" - }, - "HealthCheckId": { - "type": "string" - }, - "HostedZoneId": { - "type": "string" - }, - "HostedZoneName": { - "type": "string" - }, - "MultiValueAnswer": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Region": { - "type": "string" - }, - "ResourceRecords": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SetIdentifier": { - "type": "string" - }, - "TTL": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Weight": { - "type": "number" - } - }, - "required": [ - "Name", - "Type" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverDNSSECConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceId": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverDNSSECConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverEndpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Direction": { - "type": "string" - }, - "IpAddresses": { - "items": { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Direction", - "IpAddresses", - "SecurityGroupIds" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverEndpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverEndpoint.IpAddressRequest": { - "additionalProperties": false, - "properties": { - "Ip": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "SubnetId" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverQueryLoggingConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DestinationArn": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverQueryLoggingConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResolverQueryLogConfigId": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DomainName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ResolverEndpointId": { - "type": "string" - }, - "RuleType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TargetIps": { - "items": { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverRule.TargetAddress" - }, - "type": "array" - } - }, - "required": [ - "DomainName", - "RuleType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverRule.TargetAddress": { - "additionalProperties": false, - "properties": { - "Ip": { - "type": "string" - }, - "Port": { - "type": "string" - } - }, - "required": [ - "Ip" - ], - "type": "object" - }, - "AWS::Route53Resolver::ResolverRuleAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ResolverRuleId": { - "type": "string" - }, - "VPCId": { - "type": "string" - } - }, - "required": [ - "ResolverRuleId", - "VPCId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Route53Resolver::ResolverRuleAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3::AccessPoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Policy": { - "type": "object" - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/AWS::S3::AccessPoint.PublicAccessBlockConfiguration" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::S3::AccessPoint.VpcConfiguration" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3::AccessPoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3::AccessPoint.PublicAccessBlockConfiguration": { - "additionalProperties": false, - "properties": { - "BlockPublicAcls": { - "type": "boolean" - }, - "BlockPublicPolicy": { - "type": "boolean" - }, - "IgnorePublicAcls": { - "type": "boolean" - }, - "RestrictPublicBuckets": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::S3::AccessPoint.VpcConfiguration": { - "additionalProperties": false, - "properties": { - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccelerateConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.AccelerateConfiguration" - }, - "AccessControl": { - "type": "string" - }, - "AnalyticsConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.AnalyticsConfiguration" - }, - "type": "array" - }, - "BucketEncryption": { - "$ref": "#/definitions/AWS::S3::Bucket.BucketEncryption" - }, - "BucketName": { - "type": "string" - }, - "CorsConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.CorsConfiguration" - }, - "IntelligentTieringConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.IntelligentTieringConfiguration" - }, - "type": "array" - }, - "InventoryConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.InventoryConfiguration" - }, - "type": "array" - }, - "LifecycleConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.LifecycleConfiguration" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.LoggingConfiguration" - }, - "MetricsConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.MetricsConfiguration" - }, - "type": "array" - }, - "NotificationConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.NotificationConfiguration" - }, - "ObjectLockConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.ObjectLockConfiguration" - }, - "ObjectLockEnabled": { - "type": "boolean" - }, - "OwnershipControls": { - "$ref": "#/definitions/AWS::S3::Bucket.OwnershipControls" - }, - "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.PublicAccessBlockConfiguration" - }, - "ReplicationConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VersioningConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.VersioningConfiguration" - }, - "WebsiteConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.WebsiteConfiguration" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3::Bucket" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::S3::Bucket.AbortIncompleteMultipartUpload": { - "additionalProperties": false, - "properties": { - "DaysAfterInitiation": { - "type": "number" - } - }, - "required": [ - "DaysAfterInitiation" - ], - "type": "object" - }, - "AWS::S3::Bucket.AccelerateConfiguration": { - "additionalProperties": false, - "properties": { - "AccelerationStatus": { - "type": "string" - } - }, - "required": [ - "AccelerationStatus" - ], - "type": "object" - }, - "AWS::S3::Bucket.AccessControlTranslation": { - "additionalProperties": false, - "properties": { - "Owner": { - "type": "string" - } - }, - "required": [ - "Owner" - ], - "type": "object" - }, - "AWS::S3::Bucket.AnalyticsConfiguration": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "StorageClassAnalysis": { - "$ref": "#/definitions/AWS::S3::Bucket.StorageClassAnalysis" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - }, - "type": "array" - } - }, - "required": [ - "Id", - "StorageClassAnalysis" - ], - "type": "object" - }, - "AWS::S3::Bucket.BucketEncryption": { - "additionalProperties": false, - "properties": { - "ServerSideEncryptionConfiguration": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.ServerSideEncryptionRule" - }, - "type": "array" - } - }, - "required": [ - "ServerSideEncryptionConfiguration" - ], - "type": "object" - }, - "AWS::S3::Bucket.CorsConfiguration": { - "additionalProperties": false, - "properties": { - "CorsRules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.CorsRule" - }, - "type": "array" - } - }, - "required": [ - "CorsRules" - ], - "type": "object" - }, - "AWS::S3::Bucket.CorsRule": { - "additionalProperties": false, - "properties": { - "AllowedHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedMethods": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AllowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ExposedHeaders": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Id": { - "type": "string" - }, - "MaxAge": { - "type": "number" - } - }, - "required": [ - "AllowedMethods", - "AllowedOrigins" - ], - "type": "object" - }, - "AWS::S3::Bucket.DataExport": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::S3::Bucket.Destination" - }, - "OutputSchemaVersion": { - "type": "string" - } - }, - "required": [ - "Destination", - "OutputSchemaVersion" - ], - "type": "object" - }, - "AWS::S3::Bucket.DefaultRetention": { - "additionalProperties": false, - "properties": { - "Days": { - "type": "number" - }, - "Mode": { - "type": "string" - }, - "Years": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.DeleteMarkerReplication": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.Destination": { - "additionalProperties": false, - "properties": { - "BucketAccountId": { - "type": "string" - }, - "BucketArn": { - "type": "string" - }, - "Format": { - "type": "string" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "BucketArn", - "Format" - ], - "type": "object" - }, - "AWS::S3::Bucket.EncryptionConfiguration": { - "additionalProperties": false, - "properties": { - "ReplicaKmsKeyID": { - "type": "string" - } - }, - "required": [ - "ReplicaKmsKeyID" - ], - "type": "object" - }, - "AWS::S3::Bucket.FilterRule": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name", - "Value" - ], - "type": "object" - }, - "AWS::S3::Bucket.IntelligentTieringConfiguration": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - }, - "type": "array" - }, - "Tierings": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.Tiering" - }, - "type": "array" - } - }, - "required": [ - "Id", - "Status", - "Tierings" - ], - "type": "object" - }, - "AWS::S3::Bucket.InventoryConfiguration": { - "additionalProperties": false, - "properties": { - "Destination": { - "$ref": "#/definitions/AWS::S3::Bucket.Destination" - }, - "Enabled": { - "type": "boolean" - }, - "Id": { - "type": "string" - }, - "IncludedObjectVersions": { - "type": "string" - }, - "OptionalFields": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Prefix": { - "type": "string" - }, - "ScheduleFrequency": { - "type": "string" - } - }, - "required": [ - "Destination", - "Enabled", - "Id", - "IncludedObjectVersions", - "ScheduleFrequency" - ], - "type": "object" - }, - "AWS::S3::Bucket.LambdaConfiguration": { - "additionalProperties": false, - "properties": { - "Event": { - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/AWS::S3::Bucket.NotificationFilter" - }, - "Function": { - "type": "string" - } - }, - "required": [ - "Event", - "Function" - ], - "type": "object" - }, - "AWS::S3::Bucket.LifecycleConfiguration": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.Rule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::S3::Bucket.LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "DestinationBucketName": { - "type": "string" - }, - "LogFilePrefix": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.Metrics": { - "additionalProperties": false, - "properties": { - "EventThreshold": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationTimeValue" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.MetricsConfiguration": { - "additionalProperties": false, - "properties": { - "Id": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - }, - "type": "array" - } - }, - "required": [ - "Id" - ], - "type": "object" - }, - "AWS::S3::Bucket.NoncurrentVersionTransition": { - "additionalProperties": false, - "properties": { - "StorageClass": { - "type": "string" - }, - "TransitionInDays": { - "type": "number" - } - }, - "required": [ - "StorageClass", - "TransitionInDays" - ], - "type": "object" - }, - "AWS::S3::Bucket.NotificationConfiguration": { - "additionalProperties": false, - "properties": { - "LambdaConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.LambdaConfiguration" - }, - "type": "array" - }, - "QueueConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.QueueConfiguration" - }, - "type": "array" - }, - "TopicConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TopicConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.NotificationFilter": { - "additionalProperties": false, - "properties": { - "S3Key": { - "$ref": "#/definitions/AWS::S3::Bucket.S3KeyFilter" - } - }, - "required": [ - "S3Key" - ], - "type": "object" - }, - "AWS::S3::Bucket.ObjectLockConfiguration": { - "additionalProperties": false, - "properties": { - "ObjectLockEnabled": { - "type": "string" - }, - "Rule": { - "$ref": "#/definitions/AWS::S3::Bucket.ObjectLockRule" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.ObjectLockRule": { - "additionalProperties": false, - "properties": { - "DefaultRetention": { - "$ref": "#/definitions/AWS::S3::Bucket.DefaultRetention" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.OwnershipControls": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.OwnershipControlsRule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::S3::Bucket.OwnershipControlsRule": { - "additionalProperties": false, - "properties": { - "ObjectOwnership": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.PublicAccessBlockConfiguration": { - "additionalProperties": false, - "properties": { - "BlockPublicAcls": { - "type": "boolean" - }, - "BlockPublicPolicy": { - "type": "boolean" - }, - "IgnorePublicAcls": { - "type": "boolean" - }, - "RestrictPublicBuckets": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.QueueConfiguration": { - "additionalProperties": false, - "properties": { - "Event": { - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/AWS::S3::Bucket.NotificationFilter" - }, - "Queue": { - "type": "string" - } - }, - "required": [ - "Event", - "Queue" - ], - "type": "object" - }, - "AWS::S3::Bucket.RedirectAllRequestsTo": { - "additionalProperties": false, - "properties": { - "HostName": { - "type": "string" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "HostName" - ], - "type": "object" - }, - "AWS::S3::Bucket.RedirectRule": { - "additionalProperties": false, - "properties": { - "HostName": { - "type": "string" - }, - "HttpRedirectCode": { - "type": "string" - }, - "Protocol": { - "type": "string" - }, - "ReplaceKeyPrefixWith": { - "type": "string" - }, - "ReplaceKeyWith": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.ReplicaModifications": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.ReplicationConfiguration": { - "additionalProperties": false, - "properties": { - "Role": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationRule" - }, - "type": "array" - } - }, - "required": [ - "Role", - "Rules" - ], - "type": "object" - }, - "AWS::S3::Bucket.ReplicationDestination": { - "additionalProperties": false, - "properties": { - "AccessControlTranslation": { - "$ref": "#/definitions/AWS::S3::Bucket.AccessControlTranslation" - }, - "Account": { - "type": "string" - }, - "Bucket": { - "type": "string" - }, - "EncryptionConfiguration": { - "$ref": "#/definitions/AWS::S3::Bucket.EncryptionConfiguration" - }, - "Metrics": { - "$ref": "#/definitions/AWS::S3::Bucket.Metrics" - }, - "ReplicationTime": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationTime" - }, - "StorageClass": { - "type": "string" - } - }, - "required": [ - "Bucket" - ], - "type": "object" - }, - "AWS::S3::Bucket.ReplicationRule": { - "additionalProperties": false, - "properties": { - "DeleteMarkerReplication": { - "$ref": "#/definitions/AWS::S3::Bucket.DeleteMarkerReplication" - }, - "Destination": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationDestination" - }, - "Filter": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationRuleFilter" - }, - "Id": { - "type": "string" - }, - "Prefix": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "SourceSelectionCriteria": { - "$ref": "#/definitions/AWS::S3::Bucket.SourceSelectionCriteria" - }, - "Status": { - "type": "string" - } - }, - "required": [ - "Destination", - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.ReplicationRuleAndOperator": { - "additionalProperties": false, - "properties": { - "Prefix": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.ReplicationRuleFilter": { - "additionalProperties": false, - "properties": { - "And": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationRuleAndOperator" - }, - "Prefix": { - "type": "string" - }, - "TagFilter": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.ReplicationTime": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - }, - "Time": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicationTimeValue" - } - }, - "required": [ - "Status", - "Time" - ], - "type": "object" - }, - "AWS::S3::Bucket.ReplicationTimeValue": { - "additionalProperties": false, - "properties": { - "Minutes": { - "type": "number" - } - }, - "required": [ - "Minutes" - ], - "type": "object" - }, - "AWS::S3::Bucket.RoutingRule": { - "additionalProperties": false, - "properties": { - "RedirectRule": { - "$ref": "#/definitions/AWS::S3::Bucket.RedirectRule" - }, - "RoutingRuleCondition": { - "$ref": "#/definitions/AWS::S3::Bucket.RoutingRuleCondition" - } - }, - "required": [ - "RedirectRule" - ], - "type": "object" - }, - "AWS::S3::Bucket.RoutingRuleCondition": { - "additionalProperties": false, - "properties": { - "HttpErrorCodeReturnedEquals": { - "type": "string" - }, - "KeyPrefixEquals": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.Rule": { - "additionalProperties": false, - "properties": { - "AbortIncompleteMultipartUpload": { - "$ref": "#/definitions/AWS::S3::Bucket.AbortIncompleteMultipartUpload" - }, - "ExpirationDate": { - "type": "string" - }, - "ExpirationInDays": { - "type": "number" - }, - "Id": { - "type": "string" - }, - "NoncurrentVersionExpirationInDays": { - "type": "number" - }, - "NoncurrentVersionTransition": { - "$ref": "#/definitions/AWS::S3::Bucket.NoncurrentVersionTransition" - }, - "NoncurrentVersionTransitions": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.NoncurrentVersionTransition" - }, - "type": "array" - }, - "Prefix": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "TagFilters": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.TagFilter" - }, - "type": "array" - }, - "Transition": { - "$ref": "#/definitions/AWS::S3::Bucket.Transition" - }, - "Transitions": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.Transition" - }, - "type": "array" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.S3KeyFilter": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.FilterRule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::S3::Bucket.ServerSideEncryptionByDefault": { - "additionalProperties": false, - "properties": { - "KMSMasterKeyID": { - "type": "string" - }, - "SSEAlgorithm": { - "type": "string" - } - }, - "required": [ - "SSEAlgorithm" - ], - "type": "object" - }, - "AWS::S3::Bucket.ServerSideEncryptionRule": { - "additionalProperties": false, - "properties": { - "BucketKeyEnabled": { - "type": "boolean" - }, - "ServerSideEncryptionByDefault": { - "$ref": "#/definitions/AWS::S3::Bucket.ServerSideEncryptionByDefault" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.SourceSelectionCriteria": { - "additionalProperties": false, - "properties": { - "ReplicaModifications": { - "$ref": "#/definitions/AWS::S3::Bucket.ReplicaModifications" - }, - "SseKmsEncryptedObjects": { - "$ref": "#/definitions/AWS::S3::Bucket.SseKmsEncryptedObjects" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.SseKmsEncryptedObjects": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.StorageClassAnalysis": { - "additionalProperties": false, - "properties": { - "DataExport": { - "$ref": "#/definitions/AWS::S3::Bucket.DataExport" - } - }, - "type": "object" - }, - "AWS::S3::Bucket.TagFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::S3::Bucket.Tiering": { - "additionalProperties": false, - "properties": { - "AccessTier": { - "type": "string" - }, - "Days": { - "type": "number" - } - }, - "required": [ - "AccessTier", - "Days" - ], - "type": "object" - }, - "AWS::S3::Bucket.TopicConfiguration": { - "additionalProperties": false, - "properties": { - "Event": { - "type": "string" - }, - "Filter": { - "$ref": "#/definitions/AWS::S3::Bucket.NotificationFilter" - }, - "Topic": { - "type": "string" - } - }, - "required": [ - "Event", - "Topic" - ], - "type": "object" - }, - "AWS::S3::Bucket.Transition": { - "additionalProperties": false, - "properties": { - "StorageClass": { - "type": "string" - }, - "TransitionDate": { - "type": "string" - }, - "TransitionInDays": { - "type": "number" - } - }, - "required": [ - "StorageClass" - ], - "type": "object" - }, - "AWS::S3::Bucket.VersioningConfiguration": { - "additionalProperties": false, - "properties": { - "Status": { - "type": "string" - } - }, - "required": [ - "Status" - ], - "type": "object" - }, - "AWS::S3::Bucket.WebsiteConfiguration": { - "additionalProperties": false, - "properties": { - "ErrorDocument": { - "type": "string" - }, - "IndexDocument": { - "type": "string" - }, - "RedirectAllRequestsTo": { - "$ref": "#/definitions/AWS::S3::Bucket.RedirectAllRequestsTo" - }, - "RoutingRules": { - "items": { - "$ref": "#/definitions/AWS::S3::Bucket.RoutingRule" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::S3::BucketPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "PolicyDocument": { - "type": "object" - } - }, - "required": [ - "Bucket", - "PolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3::BucketPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3::StorageLens": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "StorageLensConfiguration": { - "$ref": "#/definitions/AWS::S3::StorageLens.StorageLensConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "StorageLensConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3::StorageLens" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3::StorageLens.AccountLevel": { - "additionalProperties": false, - "properties": { - "ActivityMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics" - }, - "BucketLevel": { - "$ref": "#/definitions/AWS::S3::StorageLens.BucketLevel" - } - }, - "required": [ - "BucketLevel" - ], - "type": "object" - }, - "AWS::S3::StorageLens.ActivityMetrics": { - "additionalProperties": false, - "properties": { - "IsEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::S3::StorageLens.AwsOrg": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::S3::StorageLens.BucketLevel": { - "additionalProperties": false, - "properties": { - "ActivityMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics" - }, - "PrefixLevel": { - "$ref": "#/definitions/AWS::S3::StorageLens.PrefixLevel" - } - }, - "type": "object" - }, - "AWS::S3::StorageLens.BucketsAndRegions": { - "additionalProperties": false, - "properties": { - "Buckets": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Regions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::S3::StorageLens.DataExport": { - "additionalProperties": false, - "properties": { - "S3BucketDestination": { - "$ref": "#/definitions/AWS::S3::StorageLens.S3BucketDestination" - } - }, - "required": [ - "S3BucketDestination" - ], - "type": "object" - }, - "AWS::S3::StorageLens.Encryption": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::S3::StorageLens.PrefixLevel": { - "additionalProperties": false, - "properties": { - "StorageMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.PrefixLevelStorageMetrics" - } - }, - "required": [ - "StorageMetrics" - ], - "type": "object" - }, - "AWS::S3::StorageLens.PrefixLevelStorageMetrics": { - "additionalProperties": false, - "properties": { - "IsEnabled": { - "type": "boolean" - }, - "SelectionCriteria": { - "$ref": "#/definitions/AWS::S3::StorageLens.SelectionCriteria" - } - }, - "type": "object" - }, - "AWS::S3::StorageLens.S3BucketDestination": { - "additionalProperties": false, - "properties": { - "AccountId": { - "type": "string" - }, - "Arn": { - "type": "string" - }, - "Encryption": { - "$ref": "#/definitions/AWS::S3::StorageLens.Encryption" - }, - "Format": { - "type": "string" - }, - "OutputSchemaVersion": { - "type": "string" - }, - "Prefix": { - "type": "string" - } - }, - "required": [ - "AccountId", - "Arn", - "Format", - "OutputSchemaVersion" - ], - "type": "object" - }, - "AWS::S3::StorageLens.SelectionCriteria": { - "additionalProperties": false, - "properties": { - "Delimiter": { - "type": "string" - }, - "MaxDepth": { - "type": "number" - }, - "MinStorageBytesPercentage": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::S3::StorageLens.StorageLensConfiguration": { - "additionalProperties": false, - "properties": { - "AccountLevel": { - "$ref": "#/definitions/AWS::S3::StorageLens.AccountLevel" - }, - "AwsOrg": { - "$ref": "#/definitions/AWS::S3::StorageLens.AwsOrg" - }, - "DataExport": { - "$ref": "#/definitions/AWS::S3::StorageLens.DataExport" - }, - "Exclude": { - "$ref": "#/definitions/AWS::S3::StorageLens.BucketsAndRegions" - }, - "Id": { - "type": "string" - }, - "Include": { - "$ref": "#/definitions/AWS::S3::StorageLens.BucketsAndRegions" - }, - "IsEnabled": { - "type": "boolean" - }, - "StorageLensArn": { - "type": "string" - } - }, - "required": [ - "AccountLevel", - "Id", - "IsEnabled" - ], - "type": "object" - }, - "AWS::S3ObjectLambda::AccessPoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ObjectLambdaConfiguration": { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.ObjectLambdaConfiguration" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3ObjectLambda::AccessPoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3ObjectLambda::AccessPoint.ObjectLambdaConfiguration": { - "additionalProperties": false, - "properties": { - "AllowedFeatures": { - "items": { - "type": "string" - }, - "type": "array" - }, - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "SupportingAccessPoint": { - "type": "string" - }, - "TransformationConfigurations": { - "items": { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.TransformationConfiguration" - }, - "type": "array" - } - }, - "required": [ - "SupportingAccessPoint", - "TransformationConfigurations" - ], - "type": "object" - }, - "AWS::S3ObjectLambda::AccessPoint.TransformationConfiguration": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ContentTransformation": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::S3ObjectLambda::AccessPointPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ObjectLambdaAccessPoint": { - "type": "string" - }, - "PolicyDocument": { - "type": "object" - } - }, - "required": [ - "ObjectLambdaAccessPoint", - "PolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3ObjectLambda::AccessPointPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3Outposts::AccessPoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Policy": { - "type": "object" - }, - "VpcConfiguration": { - "$ref": "#/definitions/AWS::S3Outposts::AccessPoint.VpcConfiguration" - } - }, - "required": [ - "Bucket", - "Name", - "VpcConfiguration" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3Outposts::AccessPoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3Outposts::AccessPoint.VpcConfiguration": { - "additionalProperties": false, - "properties": { - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3Outposts::Bucket": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "LifecycleConfiguration": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.LifecycleConfiguration" - }, - "OutpostId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "BucketName", - "OutpostId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3Outposts::Bucket" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3Outposts::Bucket.AbortIncompleteMultipartUpload": { - "additionalProperties": false, - "properties": { - "DaysAfterInitiation": { - "type": "number" - } - }, - "required": [ - "DaysAfterInitiation" - ], - "type": "object" - }, - "AWS::S3Outposts::Bucket.LifecycleConfiguration": { - "additionalProperties": false, - "properties": { - "Rules": { - "items": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.Rule" - }, - "type": "array" - } - }, - "required": [ - "Rules" - ], - "type": "object" - }, - "AWS::S3Outposts::Bucket.Rule": { - "additionalProperties": false, - "properties": { - "AbortIncompleteMultipartUpload": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.AbortIncompleteMultipartUpload" - }, - "ExpirationDate": { - "type": "string" - }, - "ExpirationInDays": { - "type": "number" - }, - "Filter": { - "type": "object" - }, - "Id": { - "type": "string" - }, - "Status": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::S3Outposts::BucketPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "PolicyDocument": { - "type": "object" - } - }, - "required": [ - "Bucket", - "PolicyDocument" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3Outposts::BucketPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3Outposts::Endpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "OutpostId": { - "type": "string" - }, - "SecurityGroupId": { - "type": "string" - }, - "SubnetId": { - "type": "string" - } - }, - "required": [ - "OutpostId", - "SecurityGroupId", - "SubnetId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::S3Outposts::Endpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::S3Outposts::Endpoint.NetworkInterface": { - "additionalProperties": false, - "properties": { - "NetworkInterfaceId": { - "type": "string" - } - }, - "required": [ - "NetworkInterfaceId" - ], - "type": "object" - }, - "AWS::SDB::Domain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SDB::Domain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SES::ConfigurationSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::ConfigurationSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SES::ConfigurationSetEventDestination": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConfigurationSetName": { - "type": "string" - }, - "EventDestination": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.EventDestination" - } - }, - "required": [ - "ConfigurationSetName", - "EventDestination" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::ConfigurationSetEventDestination" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination": { - "additionalProperties": false, - "properties": { - "DimensionConfigurations": { - "items": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SES::ConfigurationSetEventDestination.DimensionConfiguration": { - "additionalProperties": false, - "properties": { - "DefaultDimensionValue": { - "type": "string" - }, - "DimensionName": { - "type": "string" - }, - "DimensionValueSource": { - "type": "string" - } - }, - "required": [ - "DefaultDimensionValue", - "DimensionName", - "DimensionValueSource" - ], - "type": "object" - }, - "AWS::SES::ConfigurationSetEventDestination.EventDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchDestination": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.CloudWatchDestination" - }, - "Enabled": { - "type": "boolean" - }, - "KinesisFirehoseDestination": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination" - }, - "MatchingEventTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "MatchingEventTypes" - ], - "type": "object" - }, - "AWS::SES::ConfigurationSetEventDestination.KinesisFirehoseDestination": { - "additionalProperties": false, - "properties": { - "DeliveryStreamARN": { - "type": "string" - }, - "IAMRoleARN": { - "type": "string" - } - }, - "required": [ - "DeliveryStreamARN", - "IAMRoleARN" - ], - "type": "object" - }, - "AWS::SES::ReceiptFilter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Filter": { - "$ref": "#/definitions/AWS::SES::ReceiptFilter.Filter" - } - }, - "required": [ - "Filter" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::ReceiptFilter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SES::ReceiptFilter.Filter": { - "additionalProperties": false, - "properties": { - "IpFilter": { - "$ref": "#/definitions/AWS::SES::ReceiptFilter.IpFilter" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "IpFilter" - ], - "type": "object" - }, - "AWS::SES::ReceiptFilter.IpFilter": { - "additionalProperties": false, - "properties": { - "Cidr": { - "type": "string" - }, - "Policy": { - "type": "string" - } - }, - "required": [ - "Cidr", - "Policy" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "After": { - "type": "string" - }, - "Rule": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.Rule" - }, - "RuleSetName": { - "type": "string" - } - }, - "required": [ - "Rule", - "RuleSetName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::ReceiptRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.Action": { - "additionalProperties": false, - "properties": { - "AddHeaderAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.AddHeaderAction" - }, - "BounceAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.BounceAction" - }, - "LambdaAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.LambdaAction" - }, - "S3Action": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.S3Action" - }, - "SNSAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.SNSAction" - }, - "StopAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.StopAction" - }, - "WorkmailAction": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.WorkmailAction" - } - }, - "type": "object" - }, - "AWS::SES::ReceiptRule.AddHeaderAction": { - "additionalProperties": false, - "properties": { - "HeaderName": { - "type": "string" - }, - "HeaderValue": { - "type": "string" - } - }, - "required": [ - "HeaderName", - "HeaderValue" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.BounceAction": { - "additionalProperties": false, - "properties": { - "Message": { - "type": "string" - }, - "Sender": { - "type": "string" - }, - "SmtpReplyCode": { - "type": "string" - }, - "StatusCode": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "Message", - "Sender", - "SmtpReplyCode" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.LambdaAction": { - "additionalProperties": false, - "properties": { - "FunctionArn": { - "type": "string" - }, - "InvocationType": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "FunctionArn" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.Rule": { - "additionalProperties": false, - "properties": { - "Actions": { - "items": { - "$ref": "#/definitions/AWS::SES::ReceiptRule.Action" - }, - "type": "array" - }, - "Enabled": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Recipients": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ScanEnabled": { - "type": "boolean" - }, - "TlsPolicy": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SES::ReceiptRule.S3Action": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "KmsKeyArn": { - "type": "string" - }, - "ObjectKeyPrefix": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "BucketName" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.SNSAction": { - "additionalProperties": false, - "properties": { - "Encoding": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SES::ReceiptRule.StopAction": { - "additionalProperties": false, - "properties": { - "Scope": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "Scope" - ], - "type": "object" - }, - "AWS::SES::ReceiptRule.WorkmailAction": { - "additionalProperties": false, - "properties": { - "OrganizationArn": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "OrganizationArn" - ], - "type": "object" - }, - "AWS::SES::ReceiptRuleSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "RuleSetName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::ReceiptRuleSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SES::Template": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Template": { - "$ref": "#/definitions/AWS::SES::Template.Template" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SES::Template" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SES::Template.Template": { - "additionalProperties": false, - "properties": { - "HtmlPart": { - "type": "string" - }, - "SubjectPart": { - "type": "string" - }, - "TemplateName": { - "type": "string" - }, - "TextPart": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SNS::Subscription": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeliveryPolicy": { - "type": "object" - }, - "Endpoint": { - "type": "string" - }, - "FilterPolicy": { - "type": "object" - }, - "Protocol": { - "type": "string" - }, - "RawMessageDelivery": { - "type": "boolean" - }, - "RedrivePolicy": { - "type": "object" - }, - "Region": { - "type": "string" - }, - "SubscriptionRoleArn": { - "type": "string" - }, - "TopicArn": { - "type": "string" - } - }, - "required": [ - "Protocol", - "TopicArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SNS::Subscription" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SNS::Topic": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContentBasedDeduplication": { - "type": "boolean" - }, - "DisplayName": { - "type": "string" - }, - "FifoTopic": { - "type": "boolean" - }, - "KmsMasterKeyId": { - "type": "string" - }, - "Subscription": { - "items": { - "$ref": "#/definitions/AWS::SNS::Topic.Subscription" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "TopicName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SNS::Topic" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SNS::Topic.Subscription": { - "additionalProperties": false, - "properties": { - "Endpoint": { - "type": "string" - }, - "Protocol": { - "type": "string" - } - }, - "required": [ - "Endpoint", - "Protocol" - ], - "type": "object" - }, - "AWS::SNS::TopicPolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "Topics": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "PolicyDocument", - "Topics" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SNS::TopicPolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SQS::Queue": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ContentBasedDeduplication": { - "type": "boolean" - }, - "DelaySeconds": { - "type": "number" - }, - "FifoQueue": { - "type": "boolean" - }, - "KmsDataKeyReusePeriodSeconds": { - "type": "number" - }, - "KmsMasterKeyId": { - "type": "string" - }, - "MaximumMessageSize": { - "type": "number" - }, - "MessageRetentionPeriod": { - "type": "number" - }, - "QueueName": { - "type": "string" - }, - "ReceiveMessageWaitTimeSeconds": { - "type": "number" - }, - "RedrivePolicy": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VisibilityTimeout": { - "type": "number" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SQS::Queue" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SQS::QueuePolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PolicyDocument": { - "type": "object" - }, - "Queues": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "PolicyDocument", - "Queues" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SQS::QueuePolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::Association": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApplyOnlyAtCronInterval": { - "type": "boolean" - }, - "AssociationName": { - "type": "string" - }, - "AutomationTargetParameterName": { - "type": "string" - }, - "ComplianceSeverity": { - "type": "string" - }, - "DocumentVersion": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "MaxConcurrency": { - "type": "string" - }, - "MaxErrors": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OutputLocation": { - "$ref": "#/definitions/AWS::SSM::Association.InstanceAssociationOutputLocation" - }, - "Parameters": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "object" - } - }, - "type": "object" - }, - "ScheduleExpression": { - "type": "string" - }, - "SyncCompliance": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::SSM::Association.Target" - }, - "type": "array" - }, - "WaitForSuccessTimeoutSeconds": { - "type": "number" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::Association" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::Association.InstanceAssociationOutputLocation": { - "additionalProperties": false, - "properties": { - "S3Location": { - "$ref": "#/definitions/AWS::SSM::Association.S3OutputLocation" - } - }, - "type": "object" - }, - "AWS::SSM::Association.ParameterValues": { - "additionalProperties": false, - "properties": { - "ParameterValues": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSM::Association.S3OutputLocation": { - "additionalProperties": false, - "properties": { - "OutputS3BucketName": { - "type": "string" - }, - "OutputS3KeyPrefix": { - "type": "string" - }, - "OutputS3Region": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SSM::Association.Target": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key", - "Values" - ], - "type": "object" - }, - "AWS::SSM::Document": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Content": { - "type": "object" - }, - "DocumentType": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Content" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::Document" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindow": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowUnassociatedTargets": { - "type": "boolean" - }, - "Cutoff": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "Duration": { - "type": "number" - }, - "EndDate": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Schedule": { - "type": "string" - }, - "ScheduleOffset": { - "type": "number" - }, - "ScheduleTimezone": { - "type": "string" - }, - "StartDate": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AllowUnassociatedTargets", - "Cutoff", - "Duration", - "Name", - "Schedule" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::MaintenanceWindow" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTarget": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "OwnerInformation": { - "type": "string" - }, - "ResourceType": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTarget.Targets" - }, - "type": "array" - }, - "WindowId": { - "type": "string" - } - }, - "required": [ - "ResourceType", - "Targets", - "WindowId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::MaintenanceWindowTarget" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTarget.Targets": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key", - "Values" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "LoggingInfo": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.LoggingInfo" - }, - "MaxConcurrency": { - "type": "string" - }, - "MaxErrors": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "ServiceRoleArn": { - "type": "string" - }, - "Targets": { - "items": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.Target" - }, - "type": "array" - }, - "TaskArn": { - "type": "string" - }, - "TaskInvocationParameters": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters" - }, - "TaskParameters": { - "type": "object" - }, - "TaskType": { - "type": "string" - }, - "WindowId": { - "type": "string" - } - }, - "required": [ - "Priority", - "TaskArn", - "TaskType", - "WindowId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::MaintenanceWindowTask" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.LoggingInfo": { - "additionalProperties": false, - "properties": { - "Region": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Prefix": { - "type": "string" - } - }, - "required": [ - "Region", - "S3Bucket" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters": { - "additionalProperties": false, - "properties": { - "DocumentVersion": { - "type": "string" - }, - "Parameters": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters": { - "additionalProperties": false, - "properties": { - "ClientContext": { - "type": "string" - }, - "Payload": { - "type": "string" - }, - "Qualifier": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters": { - "additionalProperties": false, - "properties": { - "Comment": { - "type": "string" - }, - "DocumentHash": { - "type": "string" - }, - "DocumentHashType": { - "type": "string" - }, - "NotificationConfig": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.NotificationConfig" - }, - "OutputS3BucketName": { - "type": "string" - }, - "OutputS3KeyPrefix": { - "type": "string" - }, - "Parameters": { - "type": "object" - }, - "ServiceRoleArn": { - "type": "string" - }, - "TimeoutSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters": { - "additionalProperties": false, - "properties": { - "Input": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.NotificationConfig": { - "additionalProperties": false, - "properties": { - "NotificationArn": { - "type": "string" - }, - "NotificationEvents": { - "items": { - "type": "string" - }, - "type": "array" - }, - "NotificationType": { - "type": "string" - } - }, - "required": [ - "NotificationArn" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.Target": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Key", - "Values" - ], - "type": "object" - }, - "AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters": { - "additionalProperties": false, - "properties": { - "MaintenanceWindowAutomationParameters": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.MaintenanceWindowAutomationParameters" - }, - "MaintenanceWindowLambdaParameters": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.MaintenanceWindowLambdaParameters" - }, - "MaintenanceWindowRunCommandParameters": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.MaintenanceWindowRunCommandParameters" - }, - "MaintenanceWindowStepFunctionsParameters": { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.MaintenanceWindowStepFunctionsParameters" - } - }, - "type": "object" - }, - "AWS::SSM::Parameter": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AllowedPattern": { - "type": "string" - }, - "DataType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Policies": { - "type": "string" - }, - "Tags": { - "type": "object" - }, - "Tier": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::Parameter" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::PatchBaseline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ApprovalRules": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.RuleGroup" - }, - "ApprovedPatches": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ApprovedPatchesComplianceLevel": { - "type": "string" - }, - "ApprovedPatchesEnableNonSecurity": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "GlobalFilters": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.PatchFilterGroup" - }, - "Name": { - "type": "string" - }, - "OperatingSystem": { - "type": "string" - }, - "PatchGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RejectedPatches": { - "items": { - "type": "string" - }, - "type": "array" - }, - "RejectedPatchesAction": { - "type": "string" - }, - "Sources": { - "items": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.PatchSource" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::PatchBaseline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::PatchBaseline.PatchFilter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Values": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSM::PatchBaseline.PatchFilterGroup": { - "additionalProperties": false, - "properties": { - "PatchFilters": { - "items": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.PatchFilter" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSM::PatchBaseline.PatchSource": { - "additionalProperties": false, - "properties": { - "Configuration": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Products": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSM::PatchBaseline.PatchStringDate": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SSM::PatchBaseline.Rule": { - "additionalProperties": false, - "properties": { - "ApproveAfterDays": { - "type": "number" - }, - "ApproveUntilDate": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.PatchStringDate" - }, - "ComplianceLevel": { - "type": "string" - }, - "EnableNonSecurity": { - "type": "boolean" - }, - "PatchFilterGroup": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.PatchFilterGroup" - } - }, - "type": "object" - }, - "AWS::SSM::PatchBaseline.RuleGroup": { - "additionalProperties": false, - "properties": { - "PatchRules": { - "items": { - "$ref": "#/definitions/AWS::SSM::PatchBaseline.Rule" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSM::ResourceDataSync": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "BucketRegion": { - "type": "string" - }, - "KMSKeyArn": { - "type": "string" - }, - "S3Destination": { - "$ref": "#/definitions/AWS::SSM::ResourceDataSync.S3Destination" - }, - "SyncFormat": { - "type": "string" - }, - "SyncName": { - "type": "string" - }, - "SyncSource": { - "$ref": "#/definitions/AWS::SSM::ResourceDataSync.SyncSource" - }, - "SyncType": { - "type": "string" - } - }, - "required": [ - "SyncName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSM::ResourceDataSync" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSM::ResourceDataSync.AwsOrganizationsSource": { - "additionalProperties": false, - "properties": { - "OrganizationSourceType": { - "type": "string" - }, - "OrganizationalUnits": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "OrganizationSourceType" - ], - "type": "object" - }, - "AWS::SSM::ResourceDataSync.S3Destination": { - "additionalProperties": false, - "properties": { - "BucketName": { - "type": "string" - }, - "BucketPrefix": { - "type": "string" - }, - "BucketRegion": { - "type": "string" - }, - "KMSKeyArn": { - "type": "string" - }, - "SyncFormat": { - "type": "string" - } - }, - "required": [ - "BucketName", - "BucketRegion", - "SyncFormat" - ], - "type": "object" - }, - "AWS::SSM::ResourceDataSync.SyncSource": { - "additionalProperties": false, - "properties": { - "AwsOrganizationsSource": { - "$ref": "#/definitions/AWS::SSM::ResourceDataSync.AwsOrganizationsSource" - }, - "IncludeFutureRegions": { - "type": "boolean" - }, - "SourceRegions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SourceType": { - "type": "string" - } - }, - "required": [ - "SourceRegions", - "SourceType" - ], - "type": "object" - }, - "AWS::SSO::Assignment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InstanceArn": { - "type": "string" - }, - "PermissionSetArn": { - "type": "string" - }, - "PrincipalId": { - "type": "string" - }, - "PrincipalType": { - "type": "string" - }, - "TargetId": { - "type": "string" - }, - "TargetType": { - "type": "string" - } - }, - "required": [ - "InstanceArn", - "PermissionSetArn", - "PrincipalId", - "PrincipalType", - "TargetId", - "TargetType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSO::Assignment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSO::InstanceAccessControlAttributeConfiguration": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AccessControlAttributes": { - "items": { - "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute" - }, - "type": "array" - }, - "InstanceArn": { - "type": "string" - } - }, - "required": [ - "InstanceArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSO::InstanceAccessControlAttributeConfiguration" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValue" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValue": { - "additionalProperties": false, - "properties": { - "Source": { - "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValueSourceList" - } - }, - "required": [ - "Source" - ], - "type": "object" - }, - "AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttributeValueSourceList": { - "additionalProperties": false, - "properties": { - "AccessControlAttributeValueSourceList": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SSO::PermissionSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "InlinePolicy": { - "type": "object" - }, - "InstanceArn": { - "type": "string" - }, - "ManagedPolicies": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "RelayStateType": { - "type": "string" - }, - "SessionDuration": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "InstanceArn", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SSO::PermissionSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::App": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppName": { - "type": "string" - }, - "AppType": { - "type": "string" - }, - "DomainId": { - "type": "string" - }, - "ResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::App.ResourceSpec" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserProfileName": { - "type": "string" - } - }, - "required": [ - "AppName", - "AppType", - "DomainId", - "UserProfileName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::App" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::App.ResourceSpec": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "type": "string" - }, - "SageMakerImageArn": { - "type": "string" - }, - "SageMakerImageVersionArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::AppImageConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppImageConfigName": { - "type": "string" - }, - "KernelGatewayImageConfig": { - "$ref": "#/definitions/AWS::SageMaker::AppImageConfig.KernelGatewayImageConfig" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "AppImageConfigName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::AppImageConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::AppImageConfig.FileSystemConfig": { - "additionalProperties": false, - "properties": { - "DefaultGid": { - "type": "number" - }, - "DefaultUid": { - "type": "number" - }, - "MountPath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::AppImageConfig.KernelGatewayImageConfig": { - "additionalProperties": false, - "properties": { - "FileSystemConfig": { - "$ref": "#/definitions/AWS::SageMaker::AppImageConfig.FileSystemConfig" - }, - "KernelSpecs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::AppImageConfig.KernelSpec" - }, - "type": "array" - } - }, - "required": [ - "KernelSpecs" - ], - "type": "object" - }, - "AWS::SageMaker::AppImageConfig.KernelSpec": { - "additionalProperties": false, - "properties": { - "DisplayName": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::SageMaker::CodeRepository": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "CodeRepositoryName": { - "type": "string" - }, - "GitConfig": { - "$ref": "#/definitions/AWS::SageMaker::CodeRepository.GitConfig" - } - }, - "required": [ - "GitConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::CodeRepository" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::CodeRepository.GitConfig": { - "additionalProperties": false, - "properties": { - "Branch": { - "type": "string" - }, - "RepositoryUrl": { - "type": "string" - }, - "SecretArn": { - "type": "string" - } - }, - "required": [ - "RepositoryUrl" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataQualityAppSpecification": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DataQualityAppSpecification" - }, - "DataQualityBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DataQualityBaselineConfig" - }, - "DataQualityJobInput": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DataQualityJobInput" - }, - "DataQualityJobOutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.MonitoringOutputConfig" - }, - "JobDefinitionName": { - "type": "string" - }, - "JobResources": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.MonitoringResources" - }, - "NetworkConfig": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.NetworkConfig" - }, - "RoleArn": { - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.StoppingCondition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DataQualityAppSpecification", - "DataQualityJobInput", - "DataQualityJobOutputConfig", - "JobResources", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::DataQualityJobDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.ClusterConfig": { - "additionalProperties": false, - "properties": { - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "VolumeKmsKeyId": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.ConstraintsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.DataQualityAppSpecification": { - "additionalProperties": false, - "properties": { - "ContainerArguments": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ContainerEntrypoint": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Environment" - }, - "ImageUri": { - "type": "string" - }, - "PostAnalyticsProcessorSourceUri": { - "type": "string" - }, - "RecordPreprocessorSourceUri": { - "type": "string" - } - }, - "required": [ - "ImageUri" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.DataQualityBaselineConfig": { - "additionalProperties": false, - "properties": { - "BaseliningJobName": { - "type": "string" - }, - "ConstraintsResource": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.ConstraintsResource" - }, - "StatisticsResource": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.StatisticsResource" - } - }, - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.DataQualityJobInput": { - "additionalProperties": false, - "properties": { - "EndpointInput": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.EndpointInput" - } - }, - "required": [ - "EndpointInput" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.EndpointInput": { - "additionalProperties": false, - "properties": { - "EndpointName": { - "type": "string" - }, - "LocalPath": { - "type": "string" - }, - "S3DataDistributionType": { - "type": "string" - }, - "S3InputMode": { - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.Environment": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.MonitoringOutput": { - "additionalProperties": false, - "properties": { - "S3Output": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.MonitoringOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MonitoringOutputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.MonitoringOutput" - }, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.MonitoringResources": { - "additionalProperties": false, - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.NetworkConfig": { - "additionalProperties": false, - "properties": { - "EnableInterContainerTrafficEncryption": { - "type": "boolean" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.VpcConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.S3Output": { - "additionalProperties": false, - "properties": { - "LocalPath": { - "type": "string" - }, - "S3UploadMode": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.StatisticsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.StoppingCondition": { - "additionalProperties": false, - "properties": { - "MaxRuntimeInSeconds": { - "type": "number" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "AWS::SageMaker::DataQualityJobDefinition.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::Device": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Device": { - "type": "object" - }, - "DeviceFleetName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DeviceFleetName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Device" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Device.Device": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DeviceName": { - "type": "string" - }, - "IotThingName": { - "type": "string" - } - }, - "required": [ - "DeviceName" - ], - "type": "object" - }, - "AWS::SageMaker::DeviceFleet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DeviceFleetName": { - "type": "string" - }, - "OutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::DeviceFleet.EdgeOutputConfig" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DeviceFleetName", - "OutputConfig", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::DeviceFleet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::DeviceFleet.EdgeOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "S3OutputLocation": { - "type": "string" - } - }, - "required": [ - "S3OutputLocation" - ], - "type": "object" - }, - "AWS::SageMaker::Domain": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AppNetworkAccessType": { - "type": "string" - }, - "AuthMode": { - "type": "string" - }, - "DefaultUserSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.UserSettings" - }, - "DomainName": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "AuthMode", - "DefaultUserSettings", - "DomainName", - "SubnetIds", - "VpcId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Domain" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Domain.CustomImage": { - "additionalProperties": false, - "properties": { - "AppImageConfigName": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "ImageVersionNumber": { - "type": "number" - } - }, - "required": [ - "AppImageConfigName", - "ImageName" - ], - "type": "object" - }, - "AWS::SageMaker::Domain.JupyterServerAppSettings": { - "additionalProperties": false, - "properties": { - "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" - } - }, - "type": "object" - }, - "AWS::SageMaker::Domain.KernelGatewayAppSettings": { - "additionalProperties": false, - "properties": { - "CustomImages": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::Domain.CustomImage" - }, - "type": "array" - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" - } - }, - "type": "object" - }, - "AWS::SageMaker::Domain.ResourceSpec": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "type": "string" - }, - "SageMakerImageArn": { - "type": "string" - }, - "SageMakerImageVersionArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::Domain.SharingSettings": { - "additionalProperties": false, - "properties": { - "NotebookOutputOption": { - "type": "string" - }, - "S3KmsKeyId": { - "type": "string" - }, - "S3OutputPath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::Domain.UserSettings": { - "additionalProperties": false, - "properties": { - "ExecutionRole": { - "type": "string" - }, - "JupyterServerAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings" - }, - "KernelGatewayAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.KernelGatewayAppSettings" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SharingSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.SharingSettings" - } - }, - "type": "object" - }, - "AWS::SageMaker::Endpoint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DeploymentConfig": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.DeploymentConfig" - }, - "EndpointConfigName": { - "type": "string" - }, - "EndpointName": { - "type": "string" - }, - "ExcludeRetainedVariantProperties": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.VariantProperty" - }, - "type": "array" - }, - "RetainAllVariantProperties": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "EndpointConfigName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Endpoint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.Alarm": { - "additionalProperties": false, - "properties": { - "AlarmName": { - "type": "string" - } - }, - "required": [ - "AlarmName" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.AutoRollbackConfig": { - "additionalProperties": false, - "properties": { - "Alarms": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.Alarm" - }, - "type": "array" - } - }, - "required": [ - "Alarms" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.BlueGreenUpdatePolicy": { - "additionalProperties": false, - "properties": { - "MaximumExecutionTimeoutInSeconds": { - "type": "number" - }, - "TerminationWaitInSeconds": { - "type": "number" - }, - "TrafficRoutingConfiguration": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.TrafficRoutingConfig" - } - }, - "required": [ - "TrafficRoutingConfiguration" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.CapacitySize": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.DeploymentConfig": { - "additionalProperties": false, - "properties": { - "AutoRollbackConfiguration": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.AutoRollbackConfig" - }, - "BlueGreenUpdatePolicy": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.BlueGreenUpdatePolicy" - } - }, - "required": [ - "BlueGreenUpdatePolicy" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.TrafficRoutingConfig": { - "additionalProperties": false, - "properties": { - "CanarySize": { - "$ref": "#/definitions/AWS::SageMaker::Endpoint.CapacitySize" - }, - "Type": { - "type": "string" - }, - "WaitIntervalInSeconds": { - "type": "number" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SageMaker::Endpoint.VariantProperty": { - "additionalProperties": false, - "properties": { - "VariantPropertyType": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::EndpointConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DataCaptureConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.DataCaptureConfig" - }, - "EndpointConfigName": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "ProductionVariants": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ProductionVariant" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ProductionVariants" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::EndpointConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::EndpointConfig.CaptureContentTypeHeader": { - "additionalProperties": false, - "properties": { - "CsvContentTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "JsonContentTypes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SageMaker::EndpointConfig.CaptureOption": { - "additionalProperties": false, - "properties": { - "CaptureMode": { - "type": "string" - } - }, - "required": [ - "CaptureMode" - ], - "type": "object" - }, - "AWS::SageMaker::EndpointConfig.DataCaptureConfig": { - "additionalProperties": false, - "properties": { - "CaptureContentTypeHeader": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.CaptureContentTypeHeader" - }, - "CaptureOptions": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.CaptureOption" - }, - "type": "array" - }, - "DestinationS3Uri": { - "type": "string" - }, - "EnableCapture": { - "type": "boolean" - }, - "InitialSamplingPercentage": { - "type": "number" - }, - "KmsKeyId": { - "type": "string" - } - }, - "required": [ - "CaptureOptions", - "DestinationS3Uri", - "InitialSamplingPercentage" - ], - "type": "object" - }, - "AWS::SageMaker::EndpointConfig.ProductionVariant": { - "additionalProperties": false, - "properties": { - "AcceleratorType": { - "type": "string" - }, - "InitialInstanceCount": { - "type": "number" - }, - "InitialVariantWeight": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "ModelName": { - "type": "string" - }, - "VariantName": { - "type": "string" - } - }, - "required": [ - "InitialInstanceCount", - "InitialVariantWeight", - "InstanceType", - "ModelName", - "VariantName" - ], - "type": "object" - }, - "AWS::SageMaker::FeatureGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "EventTimeFeatureName": { - "type": "string" - }, - "FeatureDefinitions": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.FeatureDefinition" - }, - "type": "array" - }, - "FeatureGroupName": { - "type": "string" - }, - "OfflineStoreConfig": { - "type": "object" - }, - "OnlineStoreConfig": { - "type": "object" - }, - "RecordIdentifierFeatureName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "EventTimeFeatureName", - "FeatureDefinitions", - "FeatureGroupName", - "RecordIdentifierFeatureName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::FeatureGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::FeatureGroup.FeatureDefinition": { - "additionalProperties": false, - "properties": { - "FeatureName": { - "type": "string" - }, - "FeatureType": { - "type": "string" - } - }, - "required": [ - "FeatureName", - "FeatureType" - ], - "type": "object" - }, - "AWS::SageMaker::Image": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ImageDescription": { - "type": "string" - }, - "ImageDisplayName": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "ImageRoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ImageName", - "ImageRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Image" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::ImageVersion": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BaseImage": { - "type": "string" - }, - "ImageName": { - "type": "string" - } - }, - "required": [ - "BaseImage", - "ImageName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::ImageVersion" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Model": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Containers": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::Model.ContainerDefinition" - }, - "type": "array" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "InferenceExecutionConfig": { - "$ref": "#/definitions/AWS::SageMaker::Model.InferenceExecutionConfig" - }, - "ModelName": { - "type": "string" - }, - "PrimaryContainer": { - "$ref": "#/definitions/AWS::SageMaker::Model.ContainerDefinition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::Model.VpcConfig" - } - }, - "required": [ - "ExecutionRoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Model" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Model.ContainerDefinition": { - "additionalProperties": false, - "properties": { - "ContainerHostname": { - "type": "string" - }, - "Environment": { - "type": "object" - }, - "Image": { - "type": "string" - }, - "ImageConfig": { - "$ref": "#/definitions/AWS::SageMaker::Model.ImageConfig" - }, - "Mode": { - "type": "string" - }, - "ModelDataUrl": { - "type": "string" - }, - "ModelPackageName": { - "type": "string" - }, - "MultiModelConfig": { - "$ref": "#/definitions/AWS::SageMaker::Model.MultiModelConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::Model.ImageConfig": { - "additionalProperties": false, - "properties": { - "RepositoryAccessMode": { - "type": "string" - } - }, - "required": [ - "RepositoryAccessMode" - ], - "type": "object" - }, - "AWS::SageMaker::Model.InferenceExecutionConfig": { - "additionalProperties": false, - "properties": { - "Mode": { - "type": "string" - } - }, - "required": [ - "Mode" - ], - "type": "object" - }, - "AWS::SageMaker::Model.MultiModelConfig": { - "additionalProperties": false, - "properties": { - "ModelCacheSetting": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::Model.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "JobDefinitionName": { - "type": "string" - }, - "JobResources": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.MonitoringResources" - }, - "ModelBiasAppSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.ModelBiasAppSpecification" - }, - "ModelBiasBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.ModelBiasBaselineConfig" - }, - "ModelBiasJobInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.ModelBiasJobInput" - }, - "ModelBiasJobOutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.MonitoringOutputConfig" - }, - "NetworkConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.NetworkConfig" - }, - "RoleArn": { - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.StoppingCondition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "JobResources", - "ModelBiasAppSpecification", - "ModelBiasJobInput", - "ModelBiasJobOutputConfig", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::ModelBiasJobDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.ClusterConfig": { - "additionalProperties": false, - "properties": { - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "VolumeKmsKeyId": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.ConstraintsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.EndpointInput": { - "additionalProperties": false, - "properties": { - "EndTimeOffset": { - "type": "string" - }, - "EndpointName": { - "type": "string" - }, - "FeaturesAttribute": { - "type": "string" - }, - "InferenceAttribute": { - "type": "string" - }, - "LocalPath": { - "type": "string" - }, - "ProbabilityAttribute": { - "type": "string" - }, - "ProbabilityThresholdAttribute": { - "type": "number" - }, - "S3DataDistributionType": { - "type": "string" - }, - "S3InputMode": { - "type": "string" - }, - "StartTimeOffset": { - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.Environment": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.ModelBiasAppSpecification": { - "additionalProperties": false, - "properties": { - "ConfigUri": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Environment" - }, - "ImageUri": { - "type": "string" - } - }, - "required": [ - "ConfigUri", - "ImageUri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.ModelBiasBaselineConfig": { - "additionalProperties": false, - "properties": { - "BaseliningJobName": { - "type": "string" - }, - "ConstraintsResource": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.ConstraintsResource" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.ModelBiasJobInput": { - "additionalProperties": false, - "properties": { - "EndpointInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.EndpointInput" - }, - "GroundTruthS3Input": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.MonitoringGroundTruthS3Input" - } - }, - "required": [ - "EndpointInput", - "GroundTruthS3Input" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.MonitoringGroundTruthS3Input": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.MonitoringOutput": { - "additionalProperties": false, - "properties": { - "S3Output": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.MonitoringOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MonitoringOutputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.MonitoringOutput" - }, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.MonitoringResources": { - "additionalProperties": false, - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.NetworkConfig": { - "additionalProperties": false, - "properties": { - "EnableInterContainerTrafficEncryption": { - "type": "boolean" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.VpcConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.S3Output": { - "additionalProperties": false, - "properties": { - "LocalPath": { - "type": "string" - }, - "S3UploadMode": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.StoppingCondition": { - "additionalProperties": false, - "properties": { - "MaxRuntimeInSeconds": { - "type": "number" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "AWS::SageMaker::ModelBiasJobDefinition.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "JobDefinitionName": { - "type": "string" - }, - "JobResources": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringResources" - }, - "ModelExplainabilityAppSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityAppSpecification" - }, - "ModelExplainabilityBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfig" - }, - "ModelExplainabilityJobInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityJobInput" - }, - "ModelExplainabilityJobOutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringOutputConfig" - }, - "NetworkConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.NetworkConfig" - }, - "RoleArn": { - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "JobResources", - "ModelExplainabilityAppSpecification", - "ModelExplainabilityJobInput", - "ModelExplainabilityJobOutputConfig", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::ModelExplainabilityJobDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.ClusterConfig": { - "additionalProperties": false, - "properties": { - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "VolumeKmsKeyId": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.ConstraintsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointInput": { - "additionalProperties": false, - "properties": { - "EndpointName": { - "type": "string" - }, - "FeaturesAttribute": { - "type": "string" - }, - "InferenceAttribute": { - "type": "string" - }, - "LocalPath": { - "type": "string" - }, - "ProbabilityAttribute": { - "type": "string" - }, - "S3DataDistributionType": { - "type": "string" - }, - "S3InputMode": { - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.Environment": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityAppSpecification": { - "additionalProperties": false, - "properties": { - "ConfigUri": { - "type": "string" - }, - "Environment": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Environment" - }, - "ImageUri": { - "type": "string" - } - }, - "required": [ - "ConfigUri", - "ImageUri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfig": { - "additionalProperties": false, - "properties": { - "BaseliningJobName": { - "type": "string" - }, - "ConstraintsResource": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.ConstraintsResource" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.ModelExplainabilityJobInput": { - "additionalProperties": false, - "properties": { - "EndpointInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointInput" - } - }, - "required": [ - "EndpointInput" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringOutput": { - "additionalProperties": false, - "properties": { - "S3Output": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MonitoringOutputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringOutput" - }, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.MonitoringResources": { - "additionalProperties": false, - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.NetworkConfig": { - "additionalProperties": false, - "properties": { - "EnableInterContainerTrafficEncryption": { - "type": "boolean" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.VpcConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.S3Output": { - "additionalProperties": false, - "properties": { - "LocalPath": { - "type": "string" - }, - "S3UploadMode": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition": { - "additionalProperties": false, - "properties": { - "MaxRuntimeInSeconds": { - "type": "number" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "AWS::SageMaker::ModelExplainabilityJobDefinition.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::ModelPackageGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ModelPackageGroupDescription": { - "type": "string" - }, - "ModelPackageGroupName": { - "type": "string" - }, - "ModelPackageGroupPolicy": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ModelPackageGroupName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::ModelPackageGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "JobDefinitionName": { - "type": "string" - }, - "JobResources": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.MonitoringResources" - }, - "ModelQualityAppSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.ModelQualityAppSpecification" - }, - "ModelQualityBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.ModelQualityBaselineConfig" - }, - "ModelQualityJobInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.ModelQualityJobInput" - }, - "ModelQualityJobOutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.MonitoringOutputConfig" - }, - "NetworkConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.NetworkConfig" - }, - "RoleArn": { - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.StoppingCondition" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "JobResources", - "ModelQualityAppSpecification", - "ModelQualityJobInput", - "ModelQualityJobOutputConfig", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::ModelQualityJobDefinition" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.ClusterConfig": { - "additionalProperties": false, - "properties": { - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "VolumeKmsKeyId": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.ConstraintsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.EndpointInput": { - "additionalProperties": false, - "properties": { - "EndTimeOffset": { - "type": "string" - }, - "EndpointName": { - "type": "string" - }, - "InferenceAttribute": { - "type": "string" - }, - "LocalPath": { - "type": "string" - }, - "ProbabilityAttribute": { - "type": "string" - }, - "ProbabilityThresholdAttribute": { - "type": "number" - }, - "S3DataDistributionType": { - "type": "string" - }, - "S3InputMode": { - "type": "string" - }, - "StartTimeOffset": { - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.Environment": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.ModelQualityAppSpecification": { - "additionalProperties": false, - "properties": { - "ContainerArguments": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ContainerEntrypoint": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Environment": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.Environment" - }, - "ImageUri": { - "type": "string" - }, - "PostAnalyticsProcessorSourceUri": { - "type": "string" - }, - "ProblemType": { - "type": "string" - }, - "RecordPreprocessorSourceUri": { - "type": "string" - } - }, - "required": [ - "ImageUri", - "ProblemType" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.ModelQualityBaselineConfig": { - "additionalProperties": false, - "properties": { - "BaseliningJobName": { - "type": "string" - }, - "ConstraintsResource": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.ConstraintsResource" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.ModelQualityJobInput": { - "additionalProperties": false, - "properties": { - "EndpointInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.EndpointInput" - }, - "GroundTruthS3Input": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.MonitoringGroundTruthS3Input" - } - }, - "required": [ - "EndpointInput", - "GroundTruthS3Input" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.MonitoringGroundTruthS3Input": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "required": [ - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.MonitoringOutput": { - "additionalProperties": false, - "properties": { - "S3Output": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.MonitoringOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MonitoringOutputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.MonitoringOutput" - }, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.MonitoringResources": { - "additionalProperties": false, - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.NetworkConfig": { - "additionalProperties": false, - "properties": { - "EnableInterContainerTrafficEncryption": { - "type": "boolean" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition.VpcConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.S3Output": { - "additionalProperties": false, - "properties": { - "LocalPath": { - "type": "string" - }, - "S3UploadMode": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.StoppingCondition": { - "additionalProperties": false, - "properties": { - "MaxRuntimeInSeconds": { - "type": "number" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "AWS::SageMaker::ModelQualityJobDefinition.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "EndpointName": { - "type": "string" - }, - "FailureReason": { - "type": "string" - }, - "LastMonitoringExecutionSummary": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringExecutionSummary" - }, - "MonitoringScheduleConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig" - }, - "MonitoringScheduleName": { - "type": "string" - }, - "MonitoringScheduleStatus": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "MonitoringScheduleConfig", - "MonitoringScheduleName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::MonitoringSchedule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.BaselineConfig": { - "additionalProperties": false, - "properties": { - "ConstraintsResource": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.ConstraintsResource" - }, - "StatisticsResource": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.StatisticsResource" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.ClusterConfig": { - "additionalProperties": false, - "properties": { - "InstanceCount": { - "type": "number" - }, - "InstanceType": { - "type": "string" - }, - "VolumeKmsKeyId": { - "type": "string" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceCount", - "InstanceType", - "VolumeSizeInGB" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.ConstraintsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.EndpointInput": { - "additionalProperties": false, - "properties": { - "EndpointName": { - "type": "string" - }, - "LocalPath": { - "type": "string" - }, - "S3DataDistributionType": { - "type": "string" - }, - "S3InputMode": { - "type": "string" - } - }, - "required": [ - "EndpointName", - "LocalPath" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.Environment": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringAppSpecification": { - "additionalProperties": false, - "properties": { - "ContainerArguments": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ContainerEntrypoint": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ImageUri": { - "type": "string" - }, - "PostAnalyticsProcessorSourceUri": { - "type": "string" - }, - "RecordPreprocessorSourceUri": { - "type": "string" - } - }, - "required": [ - "ImageUri" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringExecutionSummary": { - "additionalProperties": false, - "properties": { - "CreationTime": { - "type": "string" - }, - "EndpointName": { - "type": "string" - }, - "FailureReason": { - "type": "string" - }, - "LastModifiedTime": { - "type": "string" - }, - "MonitoringExecutionStatus": { - "type": "string" - }, - "MonitoringScheduleName": { - "type": "string" - }, - "ProcessingJobArn": { - "type": "string" - }, - "ScheduledTime": { - "type": "string" - } - }, - "required": [ - "CreationTime", - "LastModifiedTime", - "MonitoringExecutionStatus", - "MonitoringScheduleName", - "ScheduledTime" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringInput": { - "additionalProperties": false, - "properties": { - "EndpointInput": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.EndpointInput" - } - }, - "required": [ - "EndpointInput" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringInputs": { - "additionalProperties": false, - "properties": { - "MonitoringInputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringInput" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringJobDefinition": { - "additionalProperties": false, - "properties": { - "BaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.BaselineConfig" - }, - "Environment": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.Environment" - }, - "MonitoringAppSpecification": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringAppSpecification" - }, - "MonitoringInputs": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringInputs" - }, - "MonitoringOutputConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringOutputConfig" - }, - "MonitoringResources": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringResources" - }, - "NetworkConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.NetworkConfig" - }, - "RoleArn": { - "type": "string" - }, - "StoppingCondition": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.StoppingCondition" - } - }, - "required": [ - "MonitoringAppSpecification", - "MonitoringInputs", - "MonitoringOutputConfig", - "MonitoringResources", - "RoleArn" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringOutput": { - "additionalProperties": false, - "properties": { - "S3Output": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.S3Output" - } - }, - "required": [ - "S3Output" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringOutputConfig": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "MonitoringOutputs": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringOutput" - }, - "type": "array" - } - }, - "required": [ - "MonitoringOutputs" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringResources": { - "additionalProperties": false, - "properties": { - "ClusterConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.ClusterConfig" - } - }, - "required": [ - "ClusterConfig" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig": { - "additionalProperties": false, - "properties": { - "MonitoringJobDefinition": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.MonitoringJobDefinition" - }, - "MonitoringJobDefinitionName": { - "type": "string" - }, - "MonitoringType": { - "type": "string" - }, - "ScheduleConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.ScheduleConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.NetworkConfig": { - "additionalProperties": false, - "properties": { - "EnableInterContainerTrafficEncryption": { - "type": "boolean" - }, - "EnableNetworkIsolation": { - "type": "boolean" - }, - "VpcConfig": { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule.VpcConfig" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.S3Output": { - "additionalProperties": false, - "properties": { - "LocalPath": { - "type": "string" - }, - "S3UploadMode": { - "type": "string" - }, - "S3Uri": { - "type": "string" - } - }, - "required": [ - "LocalPath", - "S3Uri" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.ScheduleConfig": { - "additionalProperties": false, - "properties": { - "ScheduleExpression": { - "type": "string" - } - }, - "required": [ - "ScheduleExpression" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.StatisticsResource": { - "additionalProperties": false, - "properties": { - "S3Uri": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.StoppingCondition": { - "additionalProperties": false, - "properties": { - "MaxRuntimeInSeconds": { - "type": "number" - } - }, - "required": [ - "MaxRuntimeInSeconds" - ], - "type": "object" - }, - "AWS::SageMaker::MonitoringSchedule.VpcConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Subnets": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "SecurityGroupIds", - "Subnets" - ], - "type": "object" - }, - "AWS::SageMaker::NotebookInstance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceleratorTypes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdditionalCodeRepositories": { - "items": { - "type": "string" - }, - "type": "array" - }, - "DefaultCodeRepository": { - "type": "string" - }, - "DirectInternetAccess": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "LifecycleConfigName": { - "type": "string" - }, - "NotebookInstanceName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "RootAccess": { - "type": "string" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VolumeSizeInGB": { - "type": "number" - } - }, - "required": [ - "InstanceType", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::NotebookInstance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::NotebookInstanceLifecycleConfig": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "NotebookInstanceLifecycleConfigName": { - "type": "string" - }, - "OnCreate": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook" - }, - "type": "array" - }, - "OnStart": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::NotebookInstanceLifecycleConfig" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SageMaker::NotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHook": { - "additionalProperties": false, - "properties": { - "Content": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::Pipeline": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PipelineDefinition": { - "type": "object" - }, - "PipelineDescription": { - "type": "string" - }, - "PipelineDisplayName": { - "type": "string" - }, - "PipelineName": { - "type": "string" - }, - "RoleArn": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PipelineDefinition", - "PipelineName", - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Pipeline" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::Project": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ProjectDescription": { - "type": "string" - }, - "ProjectName": { - "type": "string" - }, - "ServiceCatalogProvisioningDetails": { - "type": "object" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ProjectName", - "ServiceCatalogProvisioningDetails" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Project" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::UserProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DomainId": { - "type": "string" - }, - "SingleSignOnUserIdentifier": { - "type": "string" - }, - "SingleSignOnUserValue": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserProfileName": { - "type": "string" - }, - "UserSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.UserSettings" - } - }, - "required": [ - "DomainId", - "UserProfileName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::UserProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SageMaker::UserProfile.CustomImage": { - "additionalProperties": false, - "properties": { - "AppImageConfigName": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "ImageVersionNumber": { - "type": "number" - } - }, - "required": [ - "AppImageConfigName", - "ImageName" - ], - "type": "object" - }, - "AWS::SageMaker::UserProfile.JupyterServerAppSettings": { - "additionalProperties": false, - "properties": { - "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" - } - }, - "type": "object" - }, - "AWS::SageMaker::UserProfile.KernelGatewayAppSettings": { - "additionalProperties": false, - "properties": { - "CustomImages": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomImage" - }, - "type": "array" - }, - "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" - } - }, - "type": "object" - }, - "AWS::SageMaker::UserProfile.ResourceSpec": { - "additionalProperties": false, - "properties": { - "InstanceType": { - "type": "string" - }, - "SageMakerImageArn": { - "type": "string" - }, - "SageMakerImageVersionArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::UserProfile.SharingSettings": { - "additionalProperties": false, - "properties": { - "NotebookOutputOption": { - "type": "string" - }, - "S3KmsKeyId": { - "type": "string" - }, - "S3OutputPath": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SageMaker::UserProfile.UserSettings": { - "additionalProperties": false, - "properties": { - "ExecutionRole": { - "type": "string" - }, - "JupyterServerAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterServerAppSettings" - }, - "KernelGatewayAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.KernelGatewayAppSettings" - }, - "SecurityGroups": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SharingSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.SharingSettings" - } - }, - "type": "object" - }, - "AWS::SageMaker::Workteam": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "MemberDefinitions": { - "items": { - "$ref": "#/definitions/AWS::SageMaker::Workteam.MemberDefinition" - }, - "type": "array" - }, - "NotificationConfiguration": { - "$ref": "#/definitions/AWS::SageMaker::Workteam.NotificationConfiguration" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "WorkteamName": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SageMaker::Workteam" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SageMaker::Workteam.CognitoMemberDefinition": { - "additionalProperties": false, - "properties": { - "CognitoClientId": { - "type": "string" - }, - "CognitoUserGroup": { - "type": "string" - }, - "CognitoUserPool": { - "type": "string" - } - }, - "required": [ - "CognitoClientId", - "CognitoUserGroup", - "CognitoUserPool" - ], - "type": "object" - }, - "AWS::SageMaker::Workteam.MemberDefinition": { - "additionalProperties": false, - "properties": { - "CognitoMemberDefinition": { - "$ref": "#/definitions/AWS::SageMaker::Workteam.CognitoMemberDefinition" - } - }, - "required": [ - "CognitoMemberDefinition" - ], - "type": "object" - }, - "AWS::SageMaker::Workteam.NotificationConfiguration": { - "additionalProperties": false, - "properties": { - "NotificationTopicArn": { - "type": "string" - } - }, - "required": [ - "NotificationTopicArn" - ], - "type": "object" - }, - "AWS::SecretsManager::ResourcePolicy": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BlockPublicPolicy": { - "type": "boolean" - }, - "ResourcePolicy": { - "type": "object" - }, - "SecretId": { - "type": "string" - } - }, - "required": [ - "ResourcePolicy", - "SecretId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SecretsManager::ResourcePolicy" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SecretsManager::RotationSchedule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HostedRotationLambda": { - "$ref": "#/definitions/AWS::SecretsManager::RotationSchedule.HostedRotationLambda" - }, - "RotationLambdaARN": { - "type": "string" - }, - "RotationRules": { - "$ref": "#/definitions/AWS::SecretsManager::RotationSchedule.RotationRules" - }, - "SecretId": { - "type": "string" - } - }, - "required": [ - "SecretId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SecretsManager::RotationSchedule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SecretsManager::RotationSchedule.HostedRotationLambda": { - "additionalProperties": false, - "properties": { - "KmsKeyArn": { - "type": "string" - }, - "MasterSecretArn": { - "type": "string" - }, - "MasterSecretKmsKeyArn": { - "type": "string" - }, - "RotationLambdaName": { - "type": "string" - }, - "RotationType": { - "type": "string" - }, - "VpcSecurityGroupIds": { - "type": "string" - }, - "VpcSubnetIds": { - "type": "string" - } - }, - "required": [ - "RotationType" - ], - "type": "object" - }, - "AWS::SecretsManager::RotationSchedule.RotationRules": { - "additionalProperties": false, - "properties": { - "AutomaticallyAfterDays": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::SecretsManager::Secret": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "GenerateSecretString": { - "$ref": "#/definitions/AWS::SecretsManager::Secret.GenerateSecretString" - }, - "KmsKeyId": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReplicaRegions": { - "items": { - "$ref": "#/definitions/AWS::SecretsManager::Secret.ReplicaRegion" - }, - "type": "array" - }, - "SecretString": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SecretsManager::Secret" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::SecretsManager::Secret.GenerateSecretString": { - "additionalProperties": false, - "properties": { - "ExcludeCharacters": { - "type": "string" - }, - "ExcludeLowercase": { - "type": "boolean" - }, - "ExcludeNumbers": { - "type": "boolean" - }, - "ExcludePunctuation": { - "type": "boolean" - }, - "ExcludeUppercase": { - "type": "boolean" - }, - "GenerateStringKey": { - "type": "string" - }, - "IncludeSpace": { - "type": "boolean" - }, - "PasswordLength": { - "type": "number" - }, - "RequireEachIncludedType": { - "type": "boolean" - }, - "SecretStringTemplate": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::SecretsManager::Secret.ReplicaRegion": { - "additionalProperties": false, - "properties": { - "KmsKeyId": { - "type": "string" - }, - "Region": { - "type": "string" - } - }, - "required": [ - "Region" - ], - "type": "object" - }, - "AWS::SecretsManager::SecretTargetAttachment": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "SecretId": { - "type": "string" - }, - "TargetId": { - "type": "string" - }, - "TargetType": { - "type": "string" - } - }, - "required": [ - "SecretId", - "TargetId", - "TargetType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SecretsManager::SecretTargetAttachment" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::SecurityHub::Hub": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Tags": { - "type": "object" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::SecurityHub::Hub" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ServiceCatalog::AcceptedPortfolioShare": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - } - }, - "required": [ - "PortfolioId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::AcceptedPortfolioShare" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::CloudFormationProduct": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Distributor": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Owner": { - "type": "string" - }, - "ProvisioningArtifactParameters": { - "items": { - "$ref": "#/definitions/AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties" - }, - "type": "array" - }, - "ReplaceProvisioningArtifacts": { - "type": "boolean" - }, - "SupportDescription": { - "type": "string" - }, - "SupportEmail": { - "type": "string" - }, - "SupportUrl": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name", - "Owner", - "ProvisioningArtifactParameters" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::CloudFormationProduct" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::CloudFormationProduct.ProvisioningArtifactProperties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DisableTemplateValidation": { - "type": "boolean" - }, - "Info": { - "type": "object" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Info" - ], - "type": "object" - }, - "AWS::ServiceCatalog::CloudFormationProvisionedProduct": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "NotificationArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PathId": { - "type": "string" - }, - "PathName": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "ProductName": { - "type": "string" - }, - "ProvisionedProductName": { - "type": "string" - }, - "ProvisioningArtifactId": { - "type": "string" - }, - "ProvisioningArtifactName": { - "type": "string" - }, - "ProvisioningParameters": { - "items": { - "$ref": "#/definitions/AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter" - }, - "type": "array" - }, - "ProvisioningPreferences": { - "$ref": "#/definitions/AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::CloudFormationProvisionedProduct" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::ServiceCatalog::CloudFormationProvisionedProduct.ProvisioningPreferences": { - "additionalProperties": false, - "properties": { - "StackSetAccounts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StackSetFailureToleranceCount": { - "type": "number" - }, - "StackSetFailureTolerancePercentage": { - "type": "number" - }, - "StackSetMaxConcurrencyCount": { - "type": "number" - }, - "StackSetMaxConcurrencyPercentage": { - "type": "number" - }, - "StackSetOperationType": { - "type": "string" - }, - "StackSetRegions": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AWS::ServiceCatalog::LaunchNotificationConstraint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "NotificationArns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - } - }, - "required": [ - "NotificationArns", - "PortfolioId", - "ProductId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::LaunchNotificationConstraint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::LaunchRoleConstraint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "LocalRoleName": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "RoleArn": { - "type": "string" - } - }, - "required": [ - "PortfolioId", - "ProductId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::LaunchRoleConstraint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::LaunchTemplateConstraint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "Rules": { - "type": "string" - } - }, - "required": [ - "PortfolioId", - "ProductId", - "Rules" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::LaunchTemplateConstraint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::Portfolio": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "DisplayName": { - "type": "string" - }, - "ProviderName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DisplayName", - "ProviderName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::Portfolio" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::PortfolioPrincipalAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "PrincipalARN": { - "type": "string" - }, - "PrincipalType": { - "type": "string" - } - }, - "required": [ - "PortfolioId", - "PrincipalARN", - "PrincipalType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::PortfolioPrincipalAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::PortfolioProductAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "SourcePortfolioId": { - "type": "string" - } - }, - "required": [ - "PortfolioId", - "ProductId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::PortfolioProductAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::PortfolioShare": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "AccountId": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ShareTagOptions": { - "type": "boolean" - } - }, - "required": [ - "AccountId", - "PortfolioId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::PortfolioShare" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::ResourceUpdateConstraint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "TagUpdateOnProvisionedProduct": { - "type": "string" - } - }, - "required": [ - "PortfolioId", - "ProductId", - "TagUpdateOnProvisionedProduct" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::ResourceUpdateConstraint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::ServiceAction": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "Definition": { - "items": { - "$ref": "#/definitions/AWS::ServiceCatalog::ServiceAction.DefinitionParameter" - }, - "type": "array" - }, - "DefinitionType": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Definition", - "DefinitionType", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::ServiceAction" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::ServiceAction.DefinitionParameter": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::ServiceCatalog::ServiceActionAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ProductId": { - "type": "string" - }, - "ProvisioningArtifactId": { - "type": "string" - }, - "ServiceActionId": { - "type": "string" - } - }, - "required": [ - "ProductId", - "ProvisioningArtifactId", - "ServiceActionId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::ServiceActionAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::StackSetConstraint": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AcceptLanguage": { - "type": "string" - }, - "AccountList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AdminRole": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "ExecutionRole": { - "type": "string" - }, - "PortfolioId": { - "type": "string" - }, - "ProductId": { - "type": "string" - }, - "RegionList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "StackInstanceControl": { - "type": "string" - } - }, - "required": [ - "AccountList", - "AdminRole", - "Description", - "ExecutionRole", - "PortfolioId", - "ProductId", - "RegionList", - "StackInstanceControl" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::StackSetConstraint" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::TagOption": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Active": { - "type": "boolean" - }, - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::TagOption" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalog::TagOptionAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceId": { - "type": "string" - }, - "TagOptionId": { - "type": "string" - } - }, - "required": [ - "ResourceId", - "TagOptionId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalog::TagOptionAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalogAppRegistry::Application": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalogAppRegistry::Application" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalogAppRegistry::AttributeGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Attributes": { - "type": "object" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "Attributes", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalogAppRegistry::AttributeGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Application": { - "type": "string" - }, - "AttributeGroup": { - "type": "string" - } - }, - "required": [ - "Application", - "AttributeGroup" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceCatalogAppRegistry::ResourceAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Application": { - "type": "string" - }, - "Resource": { - "type": "string" - }, - "ResourceType": { - "type": "string" - } - }, - "required": [ - "Application", - "Resource", - "ResourceType" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceCatalogAppRegistry::ResourceAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::HttpNamespace": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceDiscovery::HttpNamespace" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Instance": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "InstanceAttributes": { - "type": "object" - }, - "InstanceId": { - "type": "string" - }, - "ServiceId": { - "type": "string" - } - }, - "required": [ - "InstanceAttributes", - "ServiceId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceDiscovery::Instance" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::PrivateDnsNamespace": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Vpc": { - "type": "string" - } - }, - "required": [ - "Name", - "Vpc" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceDiscovery::PrivateDnsNamespace" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::PublicDnsNamespace": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceDiscovery::PublicDnsNamespace" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Service": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "DnsConfig": { - "$ref": "#/definitions/AWS::ServiceDiscovery::Service.DnsConfig" - }, - "HealthCheckConfig": { - "$ref": "#/definitions/AWS::ServiceDiscovery::Service.HealthCheckConfig" - }, - "HealthCheckCustomConfig": { - "$ref": "#/definitions/AWS::ServiceDiscovery::Service.HealthCheckCustomConfig" - }, - "Name": { - "type": "string" - }, - "NamespaceId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "Type": { - "type": "string" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::ServiceDiscovery::Service" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Service.DnsConfig": { - "additionalProperties": false, - "properties": { - "DnsRecords": { - "items": { - "$ref": "#/definitions/AWS::ServiceDiscovery::Service.DnsRecord" - }, - "type": "array" - }, - "NamespaceId": { - "type": "string" - }, - "RoutingPolicy": { - "type": "string" - } - }, - "required": [ - "DnsRecords" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Service.DnsRecord": { - "additionalProperties": false, - "properties": { - "TTL": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "TTL", - "Type" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Service.HealthCheckConfig": { - "additionalProperties": false, - "properties": { - "FailureThreshold": { - "type": "number" - }, - "ResourcePath": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::ServiceDiscovery::Service.HealthCheckCustomConfig": { - "additionalProperties": false, - "properties": { - "FailureThreshold": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Signer::ProfilePermission": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "Principal": { - "type": "string" - }, - "ProfileName": { - "type": "string" - }, - "ProfileVersion": { - "type": "string" - }, - "StatementId": { - "type": "string" - } - }, - "required": [ - "Action", - "Principal", - "ProfileName", - "StatementId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Signer::ProfilePermission" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Signer::SigningProfile": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "PlatformId": { - "type": "string" - }, - "SignatureValidityPeriod": { - "$ref": "#/definitions/AWS::Signer::SigningProfile.SignatureValidityPeriod" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "PlatformId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Signer::SigningProfile" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Signer::SigningProfile.SignatureValidityPeriod": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::StepFunctions::Activity": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::StepFunctions::Activity.TagsEntry" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::StepFunctions::Activity" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::StepFunctions::Activity.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::StepFunctions::StateMachine": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Definition": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.Definition" - }, - "DefinitionS3Location": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.S3Location" - }, - "DefinitionString": { - "type": "string" - }, - "DefinitionSubstitutions": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "LoggingConfiguration": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.LoggingConfiguration" - }, - "RoleArn": { - "type": "string" - }, - "StateMachineName": { - "type": "string" - }, - "StateMachineType": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.TagsEntry" - }, - "type": "array" - }, - "TracingConfiguration": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.TracingConfiguration" - } - }, - "required": [ - "RoleArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::StepFunctions::StateMachine" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup": { - "additionalProperties": false, - "properties": { - "LogGroupArn": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::StepFunctions::StateMachine.Definition": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::StepFunctions::StateMachine.LogDestination": { - "additionalProperties": false, - "properties": { - "CloudWatchLogsLogGroup": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.CloudWatchLogsLogGroup" - } - }, - "type": "object" - }, - "AWS::StepFunctions::StateMachine.LoggingConfiguration": { - "additionalProperties": false, - "properties": { - "Destinations": { - "items": { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine.LogDestination" - }, - "type": "array" - }, - "IncludeExecutionData": { - "type": "boolean" - }, - "Level": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::StepFunctions::StateMachine.S3Location": { - "additionalProperties": false, - "properties": { - "Bucket": { - "type": "string" - }, - "Key": { - "type": "string" - }, - "Version": { - "type": "string" - } - }, - "required": [ - "Bucket", - "Key" - ], - "type": "object" - }, - "AWS::StepFunctions::StateMachine.TagsEntry": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - }, - "AWS::StepFunctions::StateMachine.TracingConfiguration": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "AWS::Synthetics::Canary": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ArtifactS3Location": { - "type": "string" - }, - "Code": { - "$ref": "#/definitions/AWS::Synthetics::Canary.Code" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "FailureRetentionPeriod": { - "type": "number" - }, - "Name": { - "type": "string" - }, - "RunConfig": { - "$ref": "#/definitions/AWS::Synthetics::Canary.RunConfig" - }, - "RuntimeVersion": { - "type": "string" - }, - "Schedule": { - "$ref": "#/definitions/AWS::Synthetics::Canary.Schedule" - }, - "StartCanaryAfterCreation": { - "type": "boolean" - }, - "SuccessRetentionPeriod": { - "type": "number" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VPCConfig": { - "$ref": "#/definitions/AWS::Synthetics::Canary.VPCConfig" - } - }, - "required": [ - "ArtifactS3Location", - "Code", - "ExecutionRoleArn", - "Name", - "RuntimeVersion", - "Schedule", - "StartCanaryAfterCreation" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Synthetics::Canary" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Synthetics::Canary.Code": { - "additionalProperties": false, - "properties": { - "Handler": { - "type": "string" - }, - "S3Bucket": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - }, - "Script": { - "type": "string" - } - }, - "required": [ - "Handler" - ], - "type": "object" - }, - "AWS::Synthetics::Canary.RunConfig": { - "additionalProperties": false, - "properties": { - "ActiveTracing": { - "type": "boolean" - }, - "EnvironmentVariables": { - "additionalProperties": true, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "string" - } - }, - "type": "object" - }, - "MemoryInMB": { - "type": "number" - }, - "TimeoutInSeconds": { - "type": "number" - } - }, - "type": "object" - }, - "AWS::Synthetics::Canary.Schedule": { - "additionalProperties": false, - "properties": { - "DurationInSeconds": { - "type": "string" - }, - "Expression": { - "type": "string" - } - }, - "required": [ - "Expression" - ], - "type": "object" - }, - "AWS::Synthetics::Canary.VPCConfig": { - "additionalProperties": false, - "properties": { - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcId": { - "type": "string" - } - }, - "required": [ - "SecurityGroupIds", - "SubnetIds" - ], - "type": "object" - }, - "AWS::Timestream::Database": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "KmsKeyId": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Timestream::Database" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Timestream::Table": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DatabaseName": { - "type": "string" - }, - "RetentionProperties": { - "type": "object" - }, - "TableName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "DatabaseName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Timestream::Table" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Transfer::Server": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Certificate": { - "type": "string" - }, - "Domain": { - "type": "string" - }, - "EndpointDetails": { - "$ref": "#/definitions/AWS::Transfer::Server.EndpointDetails" - }, - "EndpointType": { - "type": "string" - }, - "IdentityProviderDetails": { - "$ref": "#/definitions/AWS::Transfer::Server.IdentityProviderDetails" - }, - "IdentityProviderType": { - "type": "string" - }, - "LoggingRole": { - "type": "string" - }, - "Protocols": { - "items": { - "$ref": "#/definitions/AWS::Transfer::Server.Protocol" - }, - "type": "array" - }, - "SecurityPolicyName": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Transfer::Server" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::Transfer::Server.EndpointDetails": { - "additionalProperties": false, - "properties": { - "AddressAllocationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SecurityGroupIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "SubnetIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "VpcEndpointId": { - "type": "string" - }, - "VpcId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::Transfer::Server.IdentityProviderDetails": { - "additionalProperties": false, - "properties": { - "InvocationRole": { - "type": "string" - }, - "Url": { - "type": "string" - } - }, - "required": [ - "InvocationRole", - "Url" - ], - "type": "object" - }, - "AWS::Transfer::Server.Protocol": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::Transfer::User": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "HomeDirectory": { - "type": "string" - }, - "HomeDirectoryMappings": { - "items": { - "$ref": "#/definitions/AWS::Transfer::User.HomeDirectoryMapEntry" - }, - "type": "array" - }, - "HomeDirectoryType": { - "type": "string" - }, - "Policy": { - "type": "string" - }, - "PosixProfile": { - "$ref": "#/definitions/AWS::Transfer::User.PosixProfile" - }, - "Role": { - "type": "string" - }, - "ServerId": { - "type": "string" - }, - "SshPublicKeys": { - "items": { - "$ref": "#/definitions/AWS::Transfer::User.SshPublicKey" - }, - "type": "array" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserName": { - "type": "string" - } - }, - "required": [ - "Role", - "ServerId", - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::Transfer::User" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::Transfer::User.HomeDirectoryMapEntry": { - "additionalProperties": false, - "properties": { - "Entry": { - "type": "string" - }, - "Target": { - "type": "string" - } - }, - "required": [ - "Entry", - "Target" - ], - "type": "object" - }, - "AWS::Transfer::User.PosixProfile": { - "additionalProperties": false, - "properties": { - "Gid": { - "type": "number" - }, - "SecondaryGids": { - "items": { - "type": "number" - }, - "type": "array" - }, - "Uid": { - "type": "number" - } - }, - "required": [ - "Gid", - "Uid" - ], - "type": "object" - }, - "AWS::Transfer::User.SshPublicKey": { - "additionalProperties": false, - "properties": {}, - "type": "object" - }, - "AWS::WAF::ByteMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ByteMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAF::ByteMatchSet.ByteMatchTuple" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::ByteMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::ByteMatchSet.ByteMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAF::ByteMatchSet.FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "TargetString": { - "type": "string" - }, - "TargetStringBase64": { - "type": "string" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAF::ByteMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAF::IPSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "IPSetDescriptors": { - "items": { - "$ref": "#/definitions/AWS::WAF::IPSet.IPSetDescriptor" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::IPSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::IPSet.IPSetDescriptor": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::WAF::Rule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Predicates": { - "items": { - "$ref": "#/definitions/AWS::WAF::Rule.Predicate" - }, - "type": "array" - } - }, - "required": [ - "MetricName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::Rule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::Rule.Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "DataId", - "Negated", - "Type" - ], - "type": "object" - }, - "AWS::WAF::SizeConstraintSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SizeConstraints": { - "items": { - "$ref": "#/definitions/AWS::WAF::SizeConstraintSet.SizeConstraint" - }, - "type": "array" - } - }, - "required": [ - "Name", - "SizeConstraints" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::SizeConstraintSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::SizeConstraintSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAF::SizeConstraintSet.SizeConstraint": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAF::SizeConstraintSet.FieldToMatch" - }, - "Size": { - "type": "number" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "FieldToMatch", - "Size", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAF::SqlInjectionMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SqlInjectionMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::SqlInjectionMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::SqlInjectionMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAF::SqlInjectionMatchSet.SqlInjectionMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAF::SqlInjectionMatchSet.FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAF::WebACL": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultAction": { - "$ref": "#/definitions/AWS::WAF::WebACL.WafAction" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::WAF::WebACL.ActivatedRule" - }, - "type": "array" - } - }, - "required": [ - "DefaultAction", - "MetricName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::WebACL" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::WebACL.ActivatedRule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::WAF::WebACL.WafAction" - }, - "Priority": { - "type": "number" - }, - "RuleId": { - "type": "string" - } - }, - "required": [ - "Priority", - "RuleId" - ], - "type": "object" - }, - "AWS::WAF::WebACL.WafAction": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAF::XssMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "XssMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAF::XssMatchSet.XssMatchTuple" - }, - "type": "array" - } - }, - "required": [ - "Name", - "XssMatchTuples" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAF::XssMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAF::XssMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAF::XssMatchSet.XssMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAF::XssMatchSet.FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAFRegional::ByteMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ByteMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::ByteMatchSet.ByteMatchTuple" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::ByteMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::ByteMatchSet.ByteMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFRegional::ByteMatchSet.FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "TargetString": { - "type": "string" - }, - "TargetStringBase64": { - "type": "string" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAFRegional::ByteMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::GeoMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "GeoMatchConstraints": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::GeoMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::GeoMatchSet.GeoMatchConstraint": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::WAFRegional::IPSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "IPSetDescriptors": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::IPSet.IPSetDescriptor" - }, - "type": "array" - }, - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::IPSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::IPSet.IPSetDescriptor": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Type", - "Value" - ], - "type": "object" - }, - "AWS::WAFRegional::RateBasedRule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MatchPredicates": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::RateBasedRule.Predicate" - }, - "type": "array" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RateKey": { - "type": "string" - }, - "RateLimit": { - "type": "number" - } - }, - "required": [ - "MetricName", - "Name", - "RateKey", - "RateLimit" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::RateBasedRule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::RateBasedRule.Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "DataId", - "Negated", - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::RegexPatternSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "RegexPatternStrings": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "Name", - "RegexPatternStrings" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::RegexPatternSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::Rule": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Predicates": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::Rule.Predicate" - }, - "type": "array" - } - }, - "required": [ - "MetricName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::Rule" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::Rule.Predicate": { - "additionalProperties": false, - "properties": { - "DataId": { - "type": "string" - }, - "Negated": { - "type": "boolean" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "DataId", - "Negated", - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::SizeConstraintSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SizeConstraints": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::SizeConstraintSet.SizeConstraint" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::SizeConstraintSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::SizeConstraintSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::SizeConstraintSet.SizeConstraint": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFRegional::SizeConstraintSet.FieldToMatch" - }, - "Size": { - "type": "number" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "ComparisonOperator", - "FieldToMatch", - "Size", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAFRegional::SqlInjectionMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "SqlInjectionMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::SqlInjectionMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::SqlInjectionMatchSet.SqlInjectionMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFRegional::SqlInjectionMatchSet.FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAFRegional::WebACL": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultAction": { - "$ref": "#/definitions/AWS::WAFRegional::WebACL.Action" - }, - "MetricName": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::WebACL.Rule" - }, - "type": "array" - } - }, - "required": [ - "DefaultAction", - "MetricName", - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::WebACL" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::WebACL.Action": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::WebACL.Rule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::WAFRegional::WebACL.Action" - }, - "Priority": { - "type": "number" - }, - "RuleId": { - "type": "string" - } - }, - "required": [ - "Action", - "Priority", - "RuleId" - ], - "type": "object" - }, - "AWS::WAFRegional::WebACLAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceArn": { - "type": "string" - }, - "WebACLId": { - "type": "string" - } - }, - "required": [ - "ResourceArn", - "WebACLId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::WebACLAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::XssMatchSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "XssMatchTuples": { - "items": { - "$ref": "#/definitions/AWS::WAFRegional::XssMatchSet.XssMatchTuple" - }, - "type": "array" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFRegional::XssMatchSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFRegional::XssMatchSet.FieldToMatch": { - "additionalProperties": false, - "properties": { - "Data": { - "type": "string" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "AWS::WAFRegional::XssMatchSet.XssMatchTuple": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFRegional::XssMatchSet.FieldToMatch" - }, - "TextTransformation": { - "type": "string" - } - }, - "required": [ - "FieldToMatch", - "TextTransformation" - ], - "type": "object" - }, - "AWS::WAFv2::IPSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Addresses": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Description": { - "type": "string" - }, - "IPAddressVersion": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Scope": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "Addresses", - "IPAddressVersion", - "Scope" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFv2::IPSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFv2::RegexPatternSet": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "RegularExpressionList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "Scope": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "RegularExpressionList", - "Scope" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFv2::RegexPatternSet" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "Capacity": { - "type": "number" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Rule" - }, - "type": "array" - }, - "Scope": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VisibilityConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.VisibilityConfig" - } - }, - "required": [ - "Capacity", - "Scope", - "VisibilityConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFv2::RuleGroup" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.AndStatementOne": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementTwo" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.AndStatementTwo": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementThree" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.ByteMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "SearchString": { - "type": "string" - }, - "SearchStringBase64": { - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.FieldToMatch": { - "additionalProperties": false, - "properties": { - "AllQueryArguments": { - "type": "object" - }, - "Body": { - "type": "object" - }, - "Method": { - "type": "object" - }, - "QueryString": { - "type": "object" - }, - "SingleHeader": { - "type": "object" - }, - "SingleQueryArgument": { - "type": "object" - }, - "UriPath": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.ForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "type": "string" - }, - "HeaderName": { - "type": "string" - } - }, - "required": [ - "FallbackBehavior", - "HeaderName" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.GeoMatchStatement": { - "additionalProperties": false, - "properties": { - "CountryCodes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ForwardedIPConfiguration" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "type": "string" - }, - "HeaderName": { - "type": "string" - }, - "Position": { - "type": "string" - } - }, - "required": [ - "FallbackBehavior", - "HeaderName", - "Position" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.IPSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "IPSetForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.IPSetForwardedIPConfiguration" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.NotStatementOne": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementTwo" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.NotStatementTwo": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementThree" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.OrStatementOne": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementTwo" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.OrStatementTwo": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementThree" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.RateBasedStatementOne": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "type": "string" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ForwardedIPConfiguration" - }, - "Limit": { - "type": "number" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementTwo" - } - }, - "required": [ - "AggregateKeyType", - "Limit" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.RateBasedStatementTwo": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "type": "string" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ForwardedIPConfiguration" - }, - "Limit": { - "type": "number" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementThree" - } - }, - "required": [ - "AggregateKeyType", - "Limit" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.Rule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RuleAction" - }, - "Name": { - "type": "string" - }, - "Priority": { - "type": "number" - }, - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.StatementOne" - }, - "VisibilityConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.VisibilityConfig" - } - }, - "required": [ - "Name", - "Priority", - "Statement", - "VisibilityConfig" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.RuleAction": { - "additionalProperties": false, - "properties": { - "Allow": { - "type": "object" - }, - "Block": { - "type": "object" - }, - "Count": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.SizeConstraintStatement": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch" - }, - "Size": { - "type": "number" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "ComparisonOperator", - "FieldToMatch", - "Size", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.SqliMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.StatementOne": { - "additionalProperties": false, - "properties": { - "AndStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AndStatementOne" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.IPSetReferenceStatement" - }, - "NotStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.NotStatementOne" - }, - "OrStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.OrStatementOne" - }, - "RateBasedStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RateBasedStatementOne" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.StatementThree": { - "additionalProperties": false, - "properties": { - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.IPSetReferenceStatement" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.StatementTwo": { - "additionalProperties": false, - "properties": { - "AndStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AndStatementTwo" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.IPSetReferenceStatement" - }, - "NotStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.NotStatementTwo" - }, - "OrStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.OrStatementTwo" - }, - "RateBasedStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RateBasedStatementTwo" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RegexPatternSetReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::RuleGroup.TextTransformation": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Priority", - "Type" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.VisibilityConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "MetricName": { - "type": "string" - }, - "SampledRequestsEnabled": { - "type": "boolean" - } - }, - "required": [ - "CloudWatchMetricsEnabled", - "MetricName", - "SampledRequestsEnabled" - ], - "type": "object" - }, - "AWS::WAFv2::RuleGroup.XssMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "DefaultAction": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.DefaultAction" - }, - "Description": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Rules": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.Rule" - }, - "type": "array" - }, - "Scope": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "VisibilityConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.VisibilityConfig" - } - }, - "required": [ - "DefaultAction", - "Scope", - "VisibilityConfig" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFv2::WebACL" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.AndStatementOne": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementTwo" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.AndStatementTwo": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementThree" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.ByteMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch" - }, - "PositionalConstraint": { - "type": "string" - }, - "SearchString": { - "type": "string" - }, - "SearchStringBase64": { - "type": "string" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "PositionalConstraint", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.DefaultAction": { - "additionalProperties": false, - "properties": { - "Allow": { - "type": "object" - }, - "Block": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.ExcludedRule": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.FieldToMatch": { - "additionalProperties": false, - "properties": { - "AllQueryArguments": { - "type": "object" - }, - "Body": { - "type": "object" - }, - "Method": { - "type": "object" - }, - "QueryString": { - "type": "object" - }, - "SingleHeader": { - "type": "object" - }, - "SingleQueryArgument": { - "type": "object" - }, - "UriPath": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.ForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "type": "string" - }, - "HeaderName": { - "type": "string" - } - }, - "required": [ - "FallbackBehavior", - "HeaderName" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.GeoMatchStatement": { - "additionalProperties": false, - "properties": { - "CountryCodes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ForwardedIPConfiguration" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration": { - "additionalProperties": false, - "properties": { - "FallbackBehavior": { - "type": "string" - }, - "HeaderName": { - "type": "string" - }, - "Position": { - "type": "string" - } - }, - "required": [ - "FallbackBehavior", - "HeaderName", - "Position" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.IPSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "IPSetForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.IPSetForwardedIPConfiguration" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.ManagedRuleGroupStatement": { - "additionalProperties": false, - "properties": { - "ExcludedRules": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" - }, - "type": "array" - }, - "Name": { - "type": "string" - }, - "VendorName": { - "type": "string" - } - }, - "required": [ - "Name", - "VendorName" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.NotStatementOne": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementTwo" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.NotStatementTwo": { - "additionalProperties": false, - "properties": { - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementThree" - } - }, - "required": [ - "Statement" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.OrStatementOne": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementTwo" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.OrStatementTwo": { - "additionalProperties": false, - "properties": { - "Statements": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementThree" - }, - "type": "array" - } - }, - "required": [ - "Statements" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.OverrideAction": { - "additionalProperties": false, - "properties": { - "Count": { - "type": "object" - }, - "None": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.RateBasedStatementOne": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "type": "string" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ForwardedIPConfiguration" - }, - "Limit": { - "type": "number" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementTwo" - } - }, - "required": [ - "AggregateKeyType", - "Limit" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.RateBasedStatementTwo": { - "additionalProperties": false, - "properties": { - "AggregateKeyType": { - "type": "string" - }, - "ForwardedIPConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ForwardedIPConfiguration" - }, - "Limit": { - "type": "number" - }, - "ScopeDownStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementThree" - } - }, - "required": [ - "AggregateKeyType", - "Limit" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "Arn", - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.Rule": { - "additionalProperties": false, - "properties": { - "Action": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleAction" - }, - "Name": { - "type": "string" - }, - "OverrideAction": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.OverrideAction" - }, - "Priority": { - "type": "number" - }, - "Statement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.StatementOne" - }, - "VisibilityConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.VisibilityConfig" - } - }, - "required": [ - "Name", - "Priority", - "Statement", - "VisibilityConfig" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.RuleAction": { - "additionalProperties": false, - "properties": { - "Allow": { - "type": "object" - }, - "Block": { - "type": "object" - }, - "Count": { - "type": "object" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.RuleGroupReferenceStatement": { - "additionalProperties": false, - "properties": { - "Arn": { - "type": "string" - }, - "ExcludedRules": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" - }, - "type": "array" - } - }, - "required": [ - "Arn" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.SizeConstraintStatement": { - "additionalProperties": false, - "properties": { - "ComparisonOperator": { - "type": "string" - }, - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch" - }, - "Size": { - "type": "number" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "ComparisonOperator", - "FieldToMatch", - "Size", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.SqliMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.StatementOne": { - "additionalProperties": false, - "properties": { - "AndStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.AndStatementOne" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.IPSetReferenceStatement" - }, - "ManagedRuleGroupStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupStatement" - }, - "NotStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.NotStatementOne" - }, - "OrStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.OrStatementOne" - }, - "RateBasedStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RateBasedStatementOne" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement" - }, - "RuleGroupReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleGroupReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.StatementThree": { - "additionalProperties": false, - "properties": { - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.IPSetReferenceStatement" - }, - "ManagedRuleGroupStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupStatement" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement" - }, - "RuleGroupReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleGroupReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.StatementTwo": { - "additionalProperties": false, - "properties": { - "AndStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.AndStatementTwo" - }, - "ByteMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ByteMatchStatement" - }, - "GeoMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.GeoMatchStatement" - }, - "IPSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.IPSetReferenceStatement" - }, - "ManagedRuleGroupStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupStatement" - }, - "NotStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.NotStatementTwo" - }, - "OrStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.OrStatementTwo" - }, - "RateBasedStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RateBasedStatementTwo" - }, - "RegexPatternSetReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RegexPatternSetReferenceStatement" - }, - "RuleGroupReferenceStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleGroupReferenceStatement" - }, - "SizeConstraintStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SizeConstraintStatement" - }, - "SqliMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.SqliMatchStatement" - }, - "XssMatchStatement": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.XssMatchStatement" - } - }, - "type": "object" - }, - "AWS::WAFv2::WebACL.TextTransformation": { - "additionalProperties": false, - "properties": { - "Priority": { - "type": "number" - }, - "Type": { - "type": "string" - } - }, - "required": [ - "Priority", - "Type" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.VisibilityConfig": { - "additionalProperties": false, - "properties": { - "CloudWatchMetricsEnabled": { - "type": "boolean" - }, - "MetricName": { - "type": "string" - }, - "SampledRequestsEnabled": { - "type": "boolean" - } - }, - "required": [ - "CloudWatchMetricsEnabled", - "MetricName", - "SampledRequestsEnabled" - ], - "type": "object" - }, - "AWS::WAFv2::WebACL.XssMatchStatement": { - "additionalProperties": false, - "properties": { - "FieldToMatch": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch" - }, - "TextTransformations": { - "items": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" - }, - "type": "array" - } - }, - "required": [ - "FieldToMatch", - "TextTransformations" - ], - "type": "object" - }, - "AWS::WAFv2::WebACLAssociation": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ResourceArn": { - "type": "string" - }, - "WebACLArn": { - "type": "string" - } - }, - "required": [ - "ResourceArn", - "WebACLArn" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WAFv2::WebACLAssociation" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WorkSpaces::ConnectionAlias": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "ConnectionString": { - "type": "string" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - } - }, - "required": [ - "ConnectionString" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WorkSpaces::ConnectionAlias" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WorkSpaces::ConnectionAlias.ConnectionAliasAssociation": { - "additionalProperties": false, - "properties": { - "AssociatedAccountId": { - "type": "string" - }, - "AssociationStatus": { - "type": "string" - }, - "ConnectionIdentifier": { - "type": "string" - }, - "ResourceId": { - "type": "string" - } - }, - "type": "object" - }, - "AWS::WorkSpaces::Workspace": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "BundleId": { - "type": "string" - }, - "DirectoryId": { - "type": "string" - }, - "RootVolumeEncryptionEnabled": { - "type": "boolean" - }, - "Tags": { - "items": { - "$ref": "#/definitions/Tag" - }, - "type": "array" - }, - "UserName": { - "type": "string" - }, - "UserVolumeEncryptionEnabled": { - "type": "boolean" - }, - "VolumeEncryptionKey": { - "type": "string" - }, - "WorkspaceProperties": { - "$ref": "#/definitions/AWS::WorkSpaces::Workspace.WorkspaceProperties" - } - }, - "required": [ - "BundleId", - "DirectoryId", - "UserName" - ], - "type": "object" - }, - "Type": { - "enum": [ - "AWS::WorkSpaces::Workspace" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "AWS::WorkSpaces::Workspace.WorkspaceProperties": { - "additionalProperties": false, - "properties": { - "ComputeTypeName": { - "type": "string" - }, - "RootVolumeSizeGib": { - "type": "number" - }, - "RunningMode": { - "type": "string" - }, - "RunningModeAutoStopTimeoutInMinutes": { - "type": "number" - }, - "UserVolumeSizeGib": { - "type": "number" - } - }, - "type": "object" - }, - "Alexa::ASK::Skill": { - "additionalProperties": false, - "properties": { - "DeletionPolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - }, - "DependsOn": { - "anyOf": [ - { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - { - "items": { - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, - "type": "array" - } - ] - }, - "Metadata": { - "type": "object" - }, - "Properties": { - "additionalProperties": false, - "properties": { - "AuthenticationConfiguration": { - "$ref": "#/definitions/Alexa::ASK::Skill.AuthenticationConfiguration" - }, - "SkillPackage": { - "$ref": "#/definitions/Alexa::ASK::Skill.SkillPackage" - }, - "VendorId": { - "type": "string" - } - }, - "required": [ - "AuthenticationConfiguration", - "SkillPackage", - "VendorId" - ], - "type": "object" - }, - "Type": { - "enum": [ - "Alexa::ASK::Skill" - ], - "type": "string" - }, - "UpdateReplacePolicy": { - "enum": [ - "Delete", - "Retain", - "Snapshot" - ], - "type": "string" - } - }, - "required": [ - "Type", - "Properties" - ], - "type": "object" - }, - "Alexa::ASK::Skill.AuthenticationConfiguration": { - "additionalProperties": false, - "properties": { - "ClientId": { - "type": "string" - }, - "ClientSecret": { - "type": "string" - }, - "RefreshToken": { - "type": "string" - } - }, - "required": [ - "ClientId", - "ClientSecret", - "RefreshToken" - ], - "type": "object" - }, - "Alexa::ASK::Skill.Overrides": { - "additionalProperties": false, - "properties": { - "Manifest": { - "type": "object" - } - }, - "type": "object" - }, - "Alexa::ASK::Skill.SkillPackage": { - "additionalProperties": false, - "properties": { - "Overrides": { - "$ref": "#/definitions/Alexa::ASK::Skill.Overrides" - }, - "S3Bucket": { - "type": "string" - }, - "S3BucketRole": { - "type": "string" - }, - "S3Key": { - "type": "string" - }, - "S3ObjectVersion": { - "type": "string" - } - }, - "required": [ - "S3Bucket", - "S3Key" - ], - "type": "object" - }, - "Parameter": { - "additionalProperties": false, - "properties": { - "AllowedPattern": { - "type": "string" - }, - "AllowedValues": { - "type": "array" - }, - "ConstraintDescription": { - "type": "string" - }, - "Default": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "MaxLength": { - "type": "string" - }, - "MaxValue": { - "type": "string" - }, - "MinLength": { - "type": "string" - }, - "MinValue": { - "type": "string" - }, - "NoEcho": { - "type": [ - "string", - "boolean" - ] - }, - "Type": { - "enum": [ - "String", - "Number", - "List\u003cNumber\u003e", - "CommaDelimitedList", - "AWS::EC2::AvailabilityZone::Name", - "AWS::EC2::Image::Id", - "AWS::EC2::Instance::Id", - "AWS::EC2::KeyPair::KeyName", - "AWS::EC2::SecurityGroup::GroupName", - "AWS::EC2::SecurityGroup::Id", - "AWS::EC2::Subnet::Id", - "AWS::EC2::Volume::Id", - "AWS::EC2::VPC::Id", - "AWS::Route53::HostedZone::Id", - "List\u003cAWS::EC2::AvailabilityZone::Name\u003e", - "List\u003cAWS::EC2::Image::Id\u003e", - "List\u003cAWS::EC2::Instance::Id\u003e", - "List\u003cAWS::EC2::SecurityGroup::GroupName\u003e", - "List\u003cAWS::EC2::SecurityGroup::Id\u003e", - "List\u003cAWS::EC2::Subnet::Id\u003e", - "List\u003cAWS::EC2::Volume::Id\u003e", - "List\u003cAWS::EC2::VPC::Id\u003e", - "List\u003cAWS::Route53::HostedZone::Id\u003e", - "List\u003cString\u003e", - "AWS::SSM::Parameter::Name", - "AWS::SSM::Parameter::Value\u003cString\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cString\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cCommaDelimitedList\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::AvailabilityZone::Name\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::Image::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::Instance::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::SecurityGroup::GroupName\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::SecurityGroup::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::Subnet::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::Volume::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::EC2::VPC::Id\u003e", - "AWS::SSM::Parameter::Value\u003cAWS::Route53::HostedZone::Id\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::AvailabilityZone::Name\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::Image::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::Instance::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::SecurityGroup::GroupName\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::SecurityGroup::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::Subnet::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::Volume::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::EC2::VPC::Id\u003e\u003e", - "AWS::SSM::Parameter::Value\u003cList\u003cAWS::Route53::HostedZone::Id\u003e\u003e" - ], - "type": "string" - } - }, - "required": [ - "Type" - ], - "type": "object" - }, - "Tag": { - "additionalProperties": false, - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Key", - "Value" - ], - "type": "object" - } - }, - "properties": { - "AWSTemplateFormatVersion": { - "enum": [ - "2010-09-09" - ], - "type": "string" - }, - "Conditions": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "object" - } - }, - "type": "object" - }, - "Description": { - "description": "Template description", - "maxLength": 1024, - "type": "string" - }, - "Mappings": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "object" - } - }, - "type": "object" - }, - "Metadata": { - "type": "object" - }, - "Outputs": { - "additionalProperties": false, - "maxProperties": 60, - "minProperties": 1, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "type": "object" - } - }, - "type": "object" - }, - "Parameters": { - "additionalProperties": false, - "maxProperties": 50, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "$ref": "#/definitions/Parameter" - } - }, - "type": "object" - }, - "Resources": { - "additionalProperties": false, - "patternProperties": { - "^[a-zA-Z0-9]+$": { - "anyOf": [ - { - "$ref": "#/definitions/AWS::ACMPCA::Certificate" - }, - { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority" - }, - { - "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthorityActivation" - }, - { - "$ref": "#/definitions/AWS::AccessAnalyzer::Analyzer" - }, - { - "$ref": "#/definitions/AWS::AmazonMQ::Broker" - }, - { - "$ref": "#/definitions/AWS::AmazonMQ::Configuration" - }, - { - "$ref": "#/definitions/AWS::AmazonMQ::ConfigurationAssociation" - }, - { - "$ref": "#/definitions/AWS::Amplify::App" - }, - { - "$ref": "#/definitions/AWS::Amplify::Branch" - }, - { - "$ref": "#/definitions/AWS::Amplify::Domain" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Account" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::ApiKey" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Authorizer" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::BasePathMapping" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::ClientCertificate" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Deployment" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::DocumentationPart" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::DocumentationVersion" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::DomainName" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::GatewayResponse" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Method" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Model" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::RequestValidator" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Resource" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::RestApi" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::Stage" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlan" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::UsagePlanKey" - }, - { - "$ref": "#/definitions/AWS::ApiGateway::VpcLink" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Api" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiGatewayManagedOverrides" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::ApiMapping" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Authorizer" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Deployment" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::DomainName" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Integration" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::IntegrationResponse" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Model" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Route" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::RouteResponse" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::Stage" - }, - { - "$ref": "#/definitions/AWS::ApiGatewayV2::VpcLink" - }, - { - "$ref": "#/definitions/AWS::AppConfig::Application" - }, - { - "$ref": "#/definitions/AWS::AppConfig::ConfigurationProfile" - }, - { - "$ref": "#/definitions/AWS::AppConfig::Deployment" - }, - { - "$ref": "#/definitions/AWS::AppConfig::DeploymentStrategy" - }, - { - "$ref": "#/definitions/AWS::AppConfig::Environment" - }, - { - "$ref": "#/definitions/AWS::AppConfig::HostedConfigurationVersion" - }, - { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile" - }, - { - "$ref": "#/definitions/AWS::AppFlow::Flow" - }, - { - "$ref": "#/definitions/AWS::AppMesh::GatewayRoute" - }, - { - "$ref": "#/definitions/AWS::AppMesh::Mesh" - }, - { - "$ref": "#/definitions/AWS::AppMesh::Route" - }, - { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway" - }, - { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode" - }, - { - "$ref": "#/definitions/AWS::AppMesh::VirtualRouter" - }, - { - "$ref": "#/definitions/AWS::AppMesh::VirtualService" - }, - { - "$ref": "#/definitions/AWS::AppStream::DirectoryConfig" - }, - { - "$ref": "#/definitions/AWS::AppStream::Fleet" - }, - { - "$ref": "#/definitions/AWS::AppStream::ImageBuilder" - }, - { - "$ref": "#/definitions/AWS::AppStream::Stack" - }, - { - "$ref": "#/definitions/AWS::AppStream::StackFleetAssociation" - }, - { - "$ref": "#/definitions/AWS::AppStream::StackUserAssociation" - }, - { - "$ref": "#/definitions/AWS::AppStream::User" - }, - { - "$ref": "#/definitions/AWS::AppSync::ApiCache" - }, - { - "$ref": "#/definitions/AWS::AppSync::ApiKey" - }, - { - "$ref": "#/definitions/AWS::AppSync::DataSource" - }, - { - "$ref": "#/definitions/AWS::AppSync::FunctionConfiguration" - }, - { - "$ref": "#/definitions/AWS::AppSync::GraphQLApi" - }, - { - "$ref": "#/definitions/AWS::AppSync::GraphQLSchema" - }, - { - "$ref": "#/definitions/AWS::AppSync::Resolver" - }, - { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalableTarget" - }, - { - "$ref": "#/definitions/AWS::ApplicationAutoScaling::ScalingPolicy" - }, - { - "$ref": "#/definitions/AWS::ApplicationInsights::Application" - }, - { - "$ref": "#/definitions/AWS::Athena::DataCatalog" - }, - { - "$ref": "#/definitions/AWS::Athena::NamedQuery" - }, - { - "$ref": "#/definitions/AWS::Athena::WorkGroup" - }, - { - "$ref": "#/definitions/AWS::AuditManager::Assessment" - }, - { - "$ref": "#/definitions/AWS::AutoScaling::AutoScalingGroup" - }, - { - "$ref": "#/definitions/AWS::AutoScaling::LaunchConfiguration" - }, - { - "$ref": "#/definitions/AWS::AutoScaling::LifecycleHook" - }, - { - "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy" - }, - { - "$ref": "#/definitions/AWS::AutoScaling::ScheduledAction" - }, - { - "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan" - }, - { - "$ref": "#/definitions/AWS::Backup::BackupPlan" - }, - { - "$ref": "#/definitions/AWS::Backup::BackupSelection" - }, - { - "$ref": "#/definitions/AWS::Backup::BackupVault" - }, - { - "$ref": "#/definitions/AWS::Batch::ComputeEnvironment" - }, - { - "$ref": "#/definitions/AWS::Batch::JobDefinition" - }, - { - "$ref": "#/definitions/AWS::Batch::JobQueue" - }, - { - "$ref": "#/definitions/AWS::Budgets::Budget" - }, - { - "$ref": "#/definitions/AWS::CE::AnomalyMonitor" - }, - { - "$ref": "#/definitions/AWS::CE::AnomalySubscription" - }, - { - "$ref": "#/definitions/AWS::CE::CostCategory" - }, - { - "$ref": "#/definitions/AWS::Cassandra::Keyspace" - }, - { - "$ref": "#/definitions/AWS::Cassandra::Table" - }, - { - "$ref": "#/definitions/AWS::CertificateManager::Account" - }, - { - "$ref": "#/definitions/AWS::CertificateManager::Certificate" - }, - { - "$ref": "#/definitions/AWS::Chatbot::SlackChannelConfiguration" - }, - { - "$ref": "#/definitions/AWS::Cloud9::EnvironmentEC2" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::CustomResource" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::Macro" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::ModuleDefaultVersion" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::ModuleVersion" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::ResourceDefaultVersion" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::ResourceVersion" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::Stack" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::StackSet" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::WaitCondition" - }, - { - "$ref": "#/definitions/AWS::CloudFormation::WaitConditionHandle" - }, - { - "$ref": "#/definitions/AWS::CloudFront::CachePolicy" - }, - { - "$ref": "#/definitions/AWS::CloudFront::CloudFrontOriginAccessIdentity" - }, - { - "$ref": "#/definitions/AWS::CloudFront::Distribution" - }, - { - "$ref": "#/definitions/AWS::CloudFront::KeyGroup" - }, - { - "$ref": "#/definitions/AWS::CloudFront::OriginRequestPolicy" - }, - { - "$ref": "#/definitions/AWS::CloudFront::PublicKey" - }, - { - "$ref": "#/definitions/AWS::CloudFront::RealtimeLogConfig" - }, - { - "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution" - }, - { - "$ref": "#/definitions/AWS::CloudTrail::Trail" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::Alarm" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::CompositeAlarm" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::Dashboard" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::InsightRule" - }, - { - "$ref": "#/definitions/AWS::CloudWatch::MetricStream" - }, - { - "$ref": "#/definitions/AWS::CodeArtifact::Domain" - }, - { - "$ref": "#/definitions/AWS::CodeArtifact::Repository" - }, - { - "$ref": "#/definitions/AWS::CodeBuild::Project" - }, - { - "$ref": "#/definitions/AWS::CodeBuild::ReportGroup" - }, - { - "$ref": "#/definitions/AWS::CodeBuild::SourceCredential" - }, - { - "$ref": "#/definitions/AWS::CodeCommit::Repository" - }, - { - "$ref": "#/definitions/AWS::CodeDeploy::Application" - }, - { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig" - }, - { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup" - }, - { - "$ref": "#/definitions/AWS::CodeGuruProfiler::ProfilingGroup" - }, - { - "$ref": "#/definitions/AWS::CodeGuruReviewer::RepositoryAssociation" - }, - { - "$ref": "#/definitions/AWS::CodePipeline::CustomActionType" - }, - { - "$ref": "#/definitions/AWS::CodePipeline::Pipeline" - }, - { - "$ref": "#/definitions/AWS::CodePipeline::Webhook" - }, - { - "$ref": "#/definitions/AWS::CodeStar::GitHubRepository" - }, - { - "$ref": "#/definitions/AWS::CodeStarConnections::Connection" - }, - { - "$ref": "#/definitions/AWS::CodeStarNotifications::NotificationRule" - }, - { - "$ref": "#/definitions/AWS::Cognito::IdentityPool" - }, - { - "$ref": "#/definitions/AWS::Cognito::IdentityPoolRoleAttachment" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPool" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolClient" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolDomain" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolGroup" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolIdentityProvider" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolResourceServer" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolRiskConfigurationAttachment" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolUICustomizationAttachment" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolUser" - }, - { - "$ref": "#/definitions/AWS::Cognito::UserPoolUserToGroupAttachment" - }, - { - "$ref": "#/definitions/AWS::Config::AggregationAuthorization" - }, - { - "$ref": "#/definitions/AWS::Config::ConfigRule" - }, - { - "$ref": "#/definitions/AWS::Config::ConfigurationAggregator" - }, - { - "$ref": "#/definitions/AWS::Config::ConfigurationRecorder" - }, - { - "$ref": "#/definitions/AWS::Config::ConformancePack" - }, - { - "$ref": "#/definitions/AWS::Config::DeliveryChannel" - }, - { - "$ref": "#/definitions/AWS::Config::OrganizationConfigRule" - }, - { - "$ref": "#/definitions/AWS::Config::OrganizationConformancePack" - }, - { - "$ref": "#/definitions/AWS::Config::RemediationConfiguration" - }, - { - "$ref": "#/definitions/AWS::Config::StoredQuery" - }, - { - "$ref": "#/definitions/AWS::DAX::Cluster" - }, - { - "$ref": "#/definitions/AWS::DAX::ParameterGroup" - }, - { - "$ref": "#/definitions/AWS::DAX::SubnetGroup" - }, - { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy" - }, - { - "$ref": "#/definitions/AWS::DMS::Certificate" - }, - { - "$ref": "#/definitions/AWS::DMS::Endpoint" - }, - { - "$ref": "#/definitions/AWS::DMS::EventSubscription" - }, - { - "$ref": "#/definitions/AWS::DMS::ReplicationInstance" - }, - { - "$ref": "#/definitions/AWS::DMS::ReplicationSubnetGroup" - }, - { - "$ref": "#/definitions/AWS::DMS::ReplicationTask" - }, - { - "$ref": "#/definitions/AWS::DataBrew::Dataset" - }, - { - "$ref": "#/definitions/AWS::DataBrew::Job" - }, - { - "$ref": "#/definitions/AWS::DataBrew::Project" - }, - { - "$ref": "#/definitions/AWS::DataBrew::Recipe" - }, - { - "$ref": "#/definitions/AWS::DataBrew::Schedule" - }, - { - "$ref": "#/definitions/AWS::DataPipeline::Pipeline" - }, - { - "$ref": "#/definitions/AWS::DataSync::Agent" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationEFS" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationFSxWindows" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationNFS" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationObjectStorage" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationS3" - }, - { - "$ref": "#/definitions/AWS::DataSync::LocationSMB" - }, - { - "$ref": "#/definitions/AWS::DataSync::Task" - }, - { - "$ref": "#/definitions/AWS::Detective::Graph" - }, - { - "$ref": "#/definitions/AWS::Detective::MemberInvitation" - }, - { - "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel" - }, - { - "$ref": "#/definitions/AWS::DevOpsGuru::ResourceCollection" - }, - { - "$ref": "#/definitions/AWS::DirectoryService::MicrosoftAD" - }, - { - "$ref": "#/definitions/AWS::DirectoryService::SimpleAD" - }, - { - "$ref": "#/definitions/AWS::DocDB::DBCluster" - }, - { - "$ref": "#/definitions/AWS::DocDB::DBClusterParameterGroup" - }, - { - "$ref": "#/definitions/AWS::DocDB::DBInstance" - }, - { - "$ref": "#/definitions/AWS::DocDB::DBSubnetGroup" - }, - { - "$ref": "#/definitions/AWS::DynamoDB::Table" - }, - { - "$ref": "#/definitions/AWS::EC2::CapacityReservation" - }, - { - "$ref": "#/definitions/AWS::EC2::CarrierGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::ClientVpnAuthorizationRule" - }, - { - "$ref": "#/definitions/AWS::EC2::ClientVpnEndpoint" - }, - { - "$ref": "#/definitions/AWS::EC2::ClientVpnRoute" - }, - { - "$ref": "#/definitions/AWS::EC2::ClientVpnTargetNetworkAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::CustomerGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::DHCPOptions" - }, - { - "$ref": "#/definitions/AWS::EC2::EC2Fleet" - }, - { - "$ref": "#/definitions/AWS::EC2::EIP" - }, - { - "$ref": "#/definitions/AWS::EC2::EIPAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::EgressOnlyInternetGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::FlowLog" - }, - { - "$ref": "#/definitions/AWS::EC2::GatewayRouteTableAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::Host" - }, - { - "$ref": "#/definitions/AWS::EC2::Instance" - }, - { - "$ref": "#/definitions/AWS::EC2::InternetGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::LaunchTemplate" - }, - { - "$ref": "#/definitions/AWS::EC2::LocalGatewayRoute" - }, - { - "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTableVPCAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::NatGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkAcl" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkAclEntry" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkInsightsPath" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkInterface" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkInterfaceAttachment" - }, - { - "$ref": "#/definitions/AWS::EC2::NetworkInterfacePermission" - }, - { - "$ref": "#/definitions/AWS::EC2::PlacementGroup" - }, - { - "$ref": "#/definitions/AWS::EC2::PrefixList" - }, - { - "$ref": "#/definitions/AWS::EC2::Route" - }, - { - "$ref": "#/definitions/AWS::EC2::RouteTable" - }, - { - "$ref": "#/definitions/AWS::EC2::SecurityGroup" - }, - { - "$ref": "#/definitions/AWS::EC2::SecurityGroupEgress" - }, - { - "$ref": "#/definitions/AWS::EC2::SecurityGroupIngress" - }, - { - "$ref": "#/definitions/AWS::EC2::SpotFleet" - }, - { - "$ref": "#/definitions/AWS::EC2::Subnet" - }, - { - "$ref": "#/definitions/AWS::EC2::SubnetCidrBlock" - }, - { - "$ref": "#/definitions/AWS::EC2::SubnetNetworkAclAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::SubnetRouteTableAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorFilter" - }, - { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorFilterRule" - }, - { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorSession" - }, - { - "$ref": "#/definitions/AWS::EC2::TrafficMirrorTarget" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayAttachment" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayConnect" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayMulticastDomain" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayMulticastDomainAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayMulticastGroupMember" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayMulticastGroupSource" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayRoute" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayRouteTable" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayRouteTableAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::TransitGatewayRouteTablePropagation" - }, - { - "$ref": "#/definitions/AWS::EC2::VPC" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCCidrBlock" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCDHCPOptionsAssociation" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCEndpoint" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCEndpointConnectionNotification" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCEndpointService" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCEndpointServicePermissions" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCGatewayAttachment" - }, - { - "$ref": "#/definitions/AWS::EC2::VPCPeeringConnection" - }, - { - "$ref": "#/definitions/AWS::EC2::VPNConnection" - }, - { - "$ref": "#/definitions/AWS::EC2::VPNConnectionRoute" - }, - { - "$ref": "#/definitions/AWS::EC2::VPNGateway" - }, - { - "$ref": "#/definitions/AWS::EC2::VPNGatewayRoutePropagation" - }, - { - "$ref": "#/definitions/AWS::EC2::Volume" - }, - { - "$ref": "#/definitions/AWS::EC2::VolumeAttachment" - }, - { - "$ref": "#/definitions/AWS::ECR::PublicRepository" - }, - { - "$ref": "#/definitions/AWS::ECR::RegistryPolicy" - }, - { - "$ref": "#/definitions/AWS::ECR::ReplicationConfiguration" - }, - { - "$ref": "#/definitions/AWS::ECR::Repository" - }, - { - "$ref": "#/definitions/AWS::ECS::CapacityProvider" - }, - { - "$ref": "#/definitions/AWS::ECS::Cluster" - }, - { - "$ref": "#/definitions/AWS::ECS::ClusterCapacityProviderAssociations" - }, - { - "$ref": "#/definitions/AWS::ECS::PrimaryTaskSet" - }, - { - "$ref": "#/definitions/AWS::ECS::Service" - }, - { - "$ref": "#/definitions/AWS::ECS::TaskDefinition" - }, - { - "$ref": "#/definitions/AWS::ECS::TaskSet" - }, - { - "$ref": "#/definitions/AWS::EFS::AccessPoint" - }, - { - "$ref": "#/definitions/AWS::EFS::FileSystem" - }, - { - "$ref": "#/definitions/AWS::EFS::MountTarget" - }, - { - "$ref": "#/definitions/AWS::EKS::Addon" - }, - { - "$ref": "#/definitions/AWS::EKS::Cluster" - }, - { - "$ref": "#/definitions/AWS::EKS::FargateProfile" - }, - { - "$ref": "#/definitions/AWS::EKS::Nodegroup" - }, - { - "$ref": "#/definitions/AWS::EMR::Cluster" - }, - { - "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig" - }, - { - "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig" - }, - { - "$ref": "#/definitions/AWS::EMR::SecurityConfiguration" - }, - { - "$ref": "#/definitions/AWS::EMR::Step" - }, - { - "$ref": "#/definitions/AWS::EMR::Studio" - }, - { - "$ref": "#/definitions/AWS::EMR::StudioSessionMapping" - }, - { - "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::CacheCluster" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::ParameterGroup" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::ReplicationGroup" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::SecurityGroup" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::SecurityGroupIngress" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::SubnetGroup" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::User" - }, - { - "$ref": "#/definitions/AWS::ElastiCache::UserGroup" - }, - { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Application" - }, - { - "$ref": "#/definitions/AWS::ElasticBeanstalk::ApplicationVersion" - }, - { - "$ref": "#/definitions/AWS::ElasticBeanstalk::ConfigurationTemplate" - }, - { - "$ref": "#/definitions/AWS::ElasticBeanstalk::Environment" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancing::LoadBalancer" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::Listener" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerCertificate" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::LoadBalancer" - }, - { - "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup" - }, - { - "$ref": "#/definitions/AWS::Elasticsearch::Domain" - }, - { - "$ref": "#/definitions/AWS::EventSchemas::Discoverer" - }, - { - "$ref": "#/definitions/AWS::EventSchemas::Registry" - }, - { - "$ref": "#/definitions/AWS::EventSchemas::RegistryPolicy" - }, - { - "$ref": "#/definitions/AWS::EventSchemas::Schema" - }, - { - "$ref": "#/definitions/AWS::Events::ApiDestination" - }, - { - "$ref": "#/definitions/AWS::Events::Archive" - }, - { - "$ref": "#/definitions/AWS::Events::Connection" - }, - { - "$ref": "#/definitions/AWS::Events::EventBus" - }, - { - "$ref": "#/definitions/AWS::Events::EventBusPolicy" - }, - { - "$ref": "#/definitions/AWS::Events::Rule" - }, - { - "$ref": "#/definitions/AWS::FIS::ExperimentTemplate" - }, - { - "$ref": "#/definitions/AWS::FMS::NotificationChannel" - }, - { - "$ref": "#/definitions/AWS::FMS::Policy" - }, - { - "$ref": "#/definitions/AWS::FSx::FileSystem" - }, - { - "$ref": "#/definitions/AWS::GameLift::Alias" - }, - { - "$ref": "#/definitions/AWS::GameLift::Build" - }, - { - "$ref": "#/definitions/AWS::GameLift::Fleet" - }, - { - "$ref": "#/definitions/AWS::GameLift::GameServerGroup" - }, - { - "$ref": "#/definitions/AWS::GameLift::GameSessionQueue" - }, - { - "$ref": "#/definitions/AWS::GameLift::MatchmakingConfiguration" - }, - { - "$ref": "#/definitions/AWS::GameLift::MatchmakingRuleSet" - }, - { - "$ref": "#/definitions/AWS::GameLift::Script" - }, - { - "$ref": "#/definitions/AWS::GlobalAccelerator::Accelerator" - }, - { - "$ref": "#/definitions/AWS::GlobalAccelerator::EndpointGroup" - }, - { - "$ref": "#/definitions/AWS::GlobalAccelerator::Listener" - }, - { - "$ref": "#/definitions/AWS::Glue::Classifier" - }, - { - "$ref": "#/definitions/AWS::Glue::Connection" - }, - { - "$ref": "#/definitions/AWS::Glue::Crawler" - }, - { - "$ref": "#/definitions/AWS::Glue::DataCatalogEncryptionSettings" - }, - { - "$ref": "#/definitions/AWS::Glue::Database" - }, - { - "$ref": "#/definitions/AWS::Glue::DevEndpoint" - }, - { - "$ref": "#/definitions/AWS::Glue::Job" - }, - { - "$ref": "#/definitions/AWS::Glue::MLTransform" - }, - { - "$ref": "#/definitions/AWS::Glue::Partition" - }, - { - "$ref": "#/definitions/AWS::Glue::Registry" - }, - { - "$ref": "#/definitions/AWS::Glue::Schema" - }, - { - "$ref": "#/definitions/AWS::Glue::SchemaVersion" - }, - { - "$ref": "#/definitions/AWS::Glue::SchemaVersionMetadata" - }, - { - "$ref": "#/definitions/AWS::Glue::SecurityConfiguration" - }, - { - "$ref": "#/definitions/AWS::Glue::Table" - }, - { - "$ref": "#/definitions/AWS::Glue::Trigger" - }, - { - "$ref": "#/definitions/AWS::Glue::Workflow" - }, - { - "$ref": "#/definitions/AWS::Greengrass::ConnectorDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::ConnectorDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::CoreDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::CoreDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::DeviceDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::DeviceDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::Group" - }, - { - "$ref": "#/definitions/AWS::Greengrass::GroupVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::LoggerDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::LoggerDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::Greengrass::SubscriptionDefinition" - }, - { - "$ref": "#/definitions/AWS::Greengrass::SubscriptionDefinitionVersion" - }, - { - "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::Detector" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::Filter" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::IPSet" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::Master" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::Member" - }, - { - "$ref": "#/definitions/AWS::GuardDuty::ThreatIntelSet" - }, - { - "$ref": "#/definitions/AWS::IAM::AccessKey" - }, - { - "$ref": "#/definitions/AWS::IAM::Group" - }, - { - "$ref": "#/definitions/AWS::IAM::InstanceProfile" - }, - { - "$ref": "#/definitions/AWS::IAM::ManagedPolicy" - }, - { - "$ref": "#/definitions/AWS::IAM::OIDCProvider" - }, - { - "$ref": "#/definitions/AWS::IAM::Policy" - }, - { - "$ref": "#/definitions/AWS::IAM::Role" - }, - { - "$ref": "#/definitions/AWS::IAM::SAMLProvider" - }, - { - "$ref": "#/definitions/AWS::IAM::ServerCertificate" - }, - { - "$ref": "#/definitions/AWS::IAM::ServiceLinkedRole" - }, - { - "$ref": "#/definitions/AWS::IAM::User" - }, - { - "$ref": "#/definitions/AWS::IAM::UserToGroupAddition" - }, - { - "$ref": "#/definitions/AWS::IAM::VirtualMFADevice" - }, - { - "$ref": "#/definitions/AWS::IVS::Channel" - }, - { - "$ref": "#/definitions/AWS::IVS::PlaybackKeyPair" - }, - { - "$ref": "#/definitions/AWS::IVS::StreamKey" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::Component" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::Image" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe" - }, - { - "$ref": "#/definitions/AWS::ImageBuilder::InfrastructureConfiguration" - }, - { - "$ref": "#/definitions/AWS::Inspector::AssessmentTarget" - }, - { - "$ref": "#/definitions/AWS::Inspector::AssessmentTemplate" - }, - { - "$ref": "#/definitions/AWS::Inspector::ResourceGroup" - }, - { - "$ref": "#/definitions/AWS::IoT1Click::Device" - }, - { - "$ref": "#/definitions/AWS::IoT1Click::Placement" - }, - { - "$ref": "#/definitions/AWS::IoT1Click::Project" - }, - { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration" - }, - { - "$ref": "#/definitions/AWS::IoT::Authorizer" - }, - { - "$ref": "#/definitions/AWS::IoT::Certificate" - }, - { - "$ref": "#/definitions/AWS::IoT::CustomMetric" - }, - { - "$ref": "#/definitions/AWS::IoT::Dimension" - }, - { - "$ref": "#/definitions/AWS::IoT::DomainConfiguration" - }, - { - "$ref": "#/definitions/AWS::IoT::MitigationAction" - }, - { - "$ref": "#/definitions/AWS::IoT::Policy" - }, - { - "$ref": "#/definitions/AWS::IoT::PolicyPrincipalAttachment" - }, - { - "$ref": "#/definitions/AWS::IoT::ProvisioningTemplate" - }, - { - "$ref": "#/definitions/AWS::IoT::ScheduledAudit" - }, - { - "$ref": "#/definitions/AWS::IoT::SecurityProfile" - }, - { - "$ref": "#/definitions/AWS::IoT::Thing" - }, - { - "$ref": "#/definitions/AWS::IoT::ThingPrincipalAttachment" - }, - { - "$ref": "#/definitions/AWS::IoT::TopicRule" - }, - { - "$ref": "#/definitions/AWS::IoT::TopicRuleDestination" - }, - { - "$ref": "#/definitions/AWS::IoTAnalytics::Channel" - }, - { - "$ref": "#/definitions/AWS::IoTAnalytics::Dataset" - }, - { - "$ref": "#/definitions/AWS::IoTAnalytics::Datastore" - }, - { - "$ref": "#/definitions/AWS::IoTAnalytics::Pipeline" - }, - { - "$ref": "#/definitions/AWS::IoTEvents::DetectorModel" - }, - { - "$ref": "#/definitions/AWS::IoTEvents::Input" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::Asset" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::Dashboard" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::Gateway" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::Portal" - }, - { - "$ref": "#/definitions/AWS::IoTSiteWise::Project" - }, - { - "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate" - }, - { - "$ref": "#/definitions/AWS::IoTWireless::Destination" - }, - { - "$ref": "#/definitions/AWS::IoTWireless::DeviceProfile" - }, - { - "$ref": "#/definitions/AWS::IoTWireless::ServiceProfile" - }, - { - "$ref": "#/definitions/AWS::IoTWireless::WirelessDevice" - }, - { - "$ref": "#/definitions/AWS::IoTWireless::WirelessGateway" - }, - { - "$ref": "#/definitions/AWS::KMS::Alias" - }, - { - "$ref": "#/definitions/AWS::KMS::Key" - }, - { - "$ref": "#/definitions/AWS::Kendra::DataSource" - }, - { - "$ref": "#/definitions/AWS::Kendra::Faq" - }, - { - "$ref": "#/definitions/AWS::Kendra::Index" - }, - { - "$ref": "#/definitions/AWS::Kinesis::Stream" - }, - { - "$ref": "#/definitions/AWS::Kinesis::StreamConsumer" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalytics::Application" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationOutput" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalytics::ApplicationReferenceDataSource" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationCloudWatchLoggingOption" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationOutput" - }, - { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource" - }, - { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream" - }, - { - "$ref": "#/definitions/AWS::LakeFormation::DataLakeSettings" - }, - { - "$ref": "#/definitions/AWS::LakeFormation::Permissions" - }, - { - "$ref": "#/definitions/AWS::LakeFormation::Resource" - }, - { - "$ref": "#/definitions/AWS::Lambda::Alias" - }, - { - "$ref": "#/definitions/AWS::Lambda::CodeSigningConfig" - }, - { - "$ref": "#/definitions/AWS::Lambda::EventInvokeConfig" - }, - { - "$ref": "#/definitions/AWS::Lambda::EventSourceMapping" - }, - { - "$ref": "#/definitions/AWS::Lambda::Function" - }, - { - "$ref": "#/definitions/AWS::Lambda::LayerVersion" - }, - { - "$ref": "#/definitions/AWS::Lambda::LayerVersionPermission" - }, - { - "$ref": "#/definitions/AWS::Lambda::Permission" - }, - { - "$ref": "#/definitions/AWS::Lambda::Version" - }, - { - "$ref": "#/definitions/AWS::LicenseManager::Grant" - }, - { - "$ref": "#/definitions/AWS::LicenseManager::License" - }, - { - "$ref": "#/definitions/AWS::Logs::Destination" - }, - { - "$ref": "#/definitions/AWS::Logs::LogGroup" - }, - { - "$ref": "#/definitions/AWS::Logs::LogStream" - }, - { - "$ref": "#/definitions/AWS::Logs::MetricFilter" - }, - { - "$ref": "#/definitions/AWS::Logs::SubscriptionFilter" - }, - { - "$ref": "#/definitions/AWS::LookoutVision::Project" - }, - { - "$ref": "#/definitions/AWS::MSK::Cluster" - }, - { - "$ref": "#/definitions/AWS::MWAA::Environment" - }, - { - "$ref": "#/definitions/AWS::Macie::CustomDataIdentifier" - }, - { - "$ref": "#/definitions/AWS::Macie::FindingsFilter" - }, - { - "$ref": "#/definitions/AWS::Macie::Session" - }, - { - "$ref": "#/definitions/AWS::ManagedBlockchain::Member" - }, - { - "$ref": "#/definitions/AWS::ManagedBlockchain::Node" - }, - { - "$ref": "#/definitions/AWS::MediaConnect::Flow" - }, - { - "$ref": "#/definitions/AWS::MediaConnect::FlowEntitlement" - }, - { - "$ref": "#/definitions/AWS::MediaConnect::FlowOutput" - }, - { - "$ref": "#/definitions/AWS::MediaConnect::FlowSource" - }, - { - "$ref": "#/definitions/AWS::MediaConnect::FlowVpcInterface" - }, - { - "$ref": "#/definitions/AWS::MediaConvert::JobTemplate" - }, - { - "$ref": "#/definitions/AWS::MediaConvert::Preset" - }, - { - "$ref": "#/definitions/AWS::MediaConvert::Queue" - }, - { - "$ref": "#/definitions/AWS::MediaLive::Channel" - }, - { - "$ref": "#/definitions/AWS::MediaLive::Input" - }, - { - "$ref": "#/definitions/AWS::MediaLive::InputSecurityGroup" - }, - { - "$ref": "#/definitions/AWS::MediaPackage::Asset" - }, - { - "$ref": "#/definitions/AWS::MediaPackage::Channel" - }, - { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint" - }, - { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration" - }, - { - "$ref": "#/definitions/AWS::MediaPackage::PackagingGroup" - }, - { - "$ref": "#/definitions/AWS::MediaStore::Container" - }, - { - "$ref": "#/definitions/AWS::Neptune::DBCluster" - }, - { - "$ref": "#/definitions/AWS::Neptune::DBClusterParameterGroup" - }, - { - "$ref": "#/definitions/AWS::Neptune::DBInstance" - }, - { - "$ref": "#/definitions/AWS::Neptune::DBParameterGroup" - }, - { - "$ref": "#/definitions/AWS::Neptune::DBSubnetGroup" - }, - { - "$ref": "#/definitions/AWS::NetworkFirewall::Firewall" - }, - { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy" - }, - { - "$ref": "#/definitions/AWS::NetworkFirewall::LoggingConfiguration" - }, - { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::CustomerGatewayAssociation" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::Device" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::GlobalNetwork" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::Link" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::LinkAssociation" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::Site" - }, - { - "$ref": "#/definitions/AWS::NetworkManager::TransitGatewayRegistration" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::App" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::ElasticLoadBalancerAttachment" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::Instance" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::Layer" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::Stack" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::UserProfile" - }, - { - "$ref": "#/definitions/AWS::OpsWorks::Volume" - }, - { - "$ref": "#/definitions/AWS::OpsWorksCM::Server" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::ADMChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::APNSChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::APNSSandboxChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::APNSVoipChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::APNSVoipSandboxChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::App" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::ApplicationSettings" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::BaiduChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::Campaign" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::EmailChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::EmailTemplate" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::EventStream" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::GCMChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::PushTemplate" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::SMSChannel" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::Segment" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::SmsTemplate" - }, - { - "$ref": "#/definitions/AWS::Pinpoint::VoiceChannel" - }, - { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSet" - }, - { - "$ref": "#/definitions/AWS::PinpointEmail::ConfigurationSetEventDestination" - }, - { - "$ref": "#/definitions/AWS::PinpointEmail::DedicatedIpPool" - }, - { - "$ref": "#/definitions/AWS::PinpointEmail::Identity" - }, - { - "$ref": "#/definitions/AWS::QLDB::Ledger" - }, - { - "$ref": "#/definitions/AWS::QLDB::Stream" - }, - { - "$ref": "#/definitions/AWS::QuickSight::Analysis" - }, - { - "$ref": "#/definitions/AWS::QuickSight::Dashboard" - }, - { - "$ref": "#/definitions/AWS::QuickSight::Template" - }, - { - "$ref": "#/definitions/AWS::QuickSight::Theme" - }, - { - "$ref": "#/definitions/AWS::RAM::ResourceShare" - }, - { - "$ref": "#/definitions/AWS::RDS::DBCluster" - }, - { - "$ref": "#/definitions/AWS::RDS::DBClusterParameterGroup" - }, - { - "$ref": "#/definitions/AWS::RDS::DBInstance" - }, - { - "$ref": "#/definitions/AWS::RDS::DBParameterGroup" - }, - { - "$ref": "#/definitions/AWS::RDS::DBProxy" - }, - { - "$ref": "#/definitions/AWS::RDS::DBProxyEndpoint" - }, - { - "$ref": "#/definitions/AWS::RDS::DBProxyTargetGroup" - }, - { - "$ref": "#/definitions/AWS::RDS::DBSecurityGroup" - }, - { - "$ref": "#/definitions/AWS::RDS::DBSecurityGroupIngress" - }, - { - "$ref": "#/definitions/AWS::RDS::DBSubnetGroup" - }, - { - "$ref": "#/definitions/AWS::RDS::EventSubscription" - }, - { - "$ref": "#/definitions/AWS::RDS::GlobalCluster" - }, - { - "$ref": "#/definitions/AWS::RDS::OptionGroup" - }, - { - "$ref": "#/definitions/AWS::Redshift::Cluster" - }, - { - "$ref": "#/definitions/AWS::Redshift::ClusterParameterGroup" - }, - { - "$ref": "#/definitions/AWS::Redshift::ClusterSecurityGroup" - }, - { - "$ref": "#/definitions/AWS::Redshift::ClusterSecurityGroupIngress" - }, - { - "$ref": "#/definitions/AWS::Redshift::ClusterSubnetGroup" - }, - { - "$ref": "#/definitions/AWS::ResourceGroups::Group" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::Fleet" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::Robot" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::RobotApplication" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::RobotApplicationVersion" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication" - }, - { - "$ref": "#/definitions/AWS::RoboMaker::SimulationApplicationVersion" - }, - { - "$ref": "#/definitions/AWS::Route53::DNSSEC" - }, - { - "$ref": "#/definitions/AWS::Route53::HealthCheck" - }, - { - "$ref": "#/definitions/AWS::Route53::HostedZone" - }, - { - "$ref": "#/definitions/AWS::Route53::KeySigningKey" - }, - { - "$ref": "#/definitions/AWS::Route53::RecordSet" - }, - { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverDNSSECConfig" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverEndpoint" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverQueryLoggingConfig" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverRule" - }, - { - "$ref": "#/definitions/AWS::Route53Resolver::ResolverRuleAssociation" - }, - { - "$ref": "#/definitions/AWS::S3::AccessPoint" - }, - { - "$ref": "#/definitions/AWS::S3::Bucket" - }, - { - "$ref": "#/definitions/AWS::S3::BucketPolicy" - }, - { - "$ref": "#/definitions/AWS::S3::StorageLens" - }, - { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint" - }, - { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPointPolicy" - }, - { - "$ref": "#/definitions/AWS::S3Outposts::AccessPoint" - }, - { - "$ref": "#/definitions/AWS::S3Outposts::Bucket" - }, - { - "$ref": "#/definitions/AWS::S3Outposts::BucketPolicy" - }, - { - "$ref": "#/definitions/AWS::S3Outposts::Endpoint" - }, - { - "$ref": "#/definitions/AWS::SDB::Domain" - }, - { - "$ref": "#/definitions/AWS::SES::ConfigurationSet" - }, - { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination" - }, - { - "$ref": "#/definitions/AWS::SES::ReceiptFilter" - }, - { - "$ref": "#/definitions/AWS::SES::ReceiptRule" - }, - { - "$ref": "#/definitions/AWS::SES::ReceiptRuleSet" - }, - { - "$ref": "#/definitions/AWS::SES::Template" - }, - { - "$ref": "#/definitions/AWS::SNS::Subscription" - }, - { - "$ref": "#/definitions/AWS::SNS::Topic" - }, - { - "$ref": "#/definitions/AWS::SNS::TopicPolicy" - }, - { - "$ref": "#/definitions/AWS::SQS::Queue" - }, - { - "$ref": "#/definitions/AWS::SQS::QueuePolicy" - }, - { - "$ref": "#/definitions/AWS::SSM::Association" - }, - { - "$ref": "#/definitions/AWS::SSM::Document" - }, - { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindow" - }, - { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTarget" - }, - { - "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask" - }, - { - "$ref": "#/definitions/AWS::SSM::Parameter" - }, - { - "$ref": "#/definitions/AWS::SSM::PatchBaseline" - }, - { - "$ref": "#/definitions/AWS::SSM::ResourceDataSync" - }, - { - "$ref": "#/definitions/AWS::SSO::Assignment" - }, - { - "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration" - }, - { - "$ref": "#/definitions/AWS::SSO::PermissionSet" - }, - { - "$ref": "#/definitions/AWS::SageMaker::App" - }, - { - "$ref": "#/definitions/AWS::SageMaker::AppImageConfig" - }, - { - "$ref": "#/definitions/AWS::SageMaker::CodeRepository" - }, - { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Device" - }, - { - "$ref": "#/definitions/AWS::SageMaker::DeviceFleet" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Domain" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Endpoint" - }, - { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig" - }, - { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Image" - }, - { - "$ref": "#/definitions/AWS::SageMaker::ImageVersion" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Model" - }, - { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition" - }, - { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition" - }, - { - "$ref": "#/definitions/AWS::SageMaker::ModelPackageGroup" - }, - { - "$ref": "#/definitions/AWS::SageMaker::ModelQualityJobDefinition" - }, - { - "$ref": "#/definitions/AWS::SageMaker::MonitoringSchedule" - }, - { - "$ref": "#/definitions/AWS::SageMaker::NotebookInstance" - }, - { - "$ref": "#/definitions/AWS::SageMaker::NotebookInstanceLifecycleConfig" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Pipeline" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Project" - }, - { - "$ref": "#/definitions/AWS::SageMaker::UserProfile" - }, - { - "$ref": "#/definitions/AWS::SageMaker::Workteam" - }, - { - "$ref": "#/definitions/AWS::SecretsManager::ResourcePolicy" - }, - { - "$ref": "#/definitions/AWS::SecretsManager::RotationSchedule" - }, - { - "$ref": "#/definitions/AWS::SecretsManager::Secret" - }, - { - "$ref": "#/definitions/AWS::SecretsManager::SecretTargetAttachment" - }, - { - "$ref": "#/definitions/AWS::SecurityHub::Hub" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::AcceptedPortfolioShare" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::CloudFormationProduct" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::CloudFormationProvisionedProduct" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::LaunchNotificationConstraint" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::LaunchRoleConstraint" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::LaunchTemplateConstraint" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::Portfolio" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::PortfolioPrincipalAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::PortfolioProductAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::PortfolioShare" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::ResourceUpdateConstraint" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::ServiceAction" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::ServiceActionAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::StackSetConstraint" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::TagOption" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalog::TagOptionAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalogAppRegistry::Application" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalogAppRegistry::AttributeGroup" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceCatalogAppRegistry::ResourceAssociation" - }, - { - "$ref": "#/definitions/AWS::ServiceDiscovery::HttpNamespace" - }, - { - "$ref": "#/definitions/AWS::ServiceDiscovery::Instance" - }, - { - "$ref": "#/definitions/AWS::ServiceDiscovery::PrivateDnsNamespace" - }, - { - "$ref": "#/definitions/AWS::ServiceDiscovery::PublicDnsNamespace" - }, - { - "$ref": "#/definitions/AWS::ServiceDiscovery::Service" - }, - { - "$ref": "#/definitions/AWS::Signer::ProfilePermission" - }, - { - "$ref": "#/definitions/AWS::Signer::SigningProfile" - }, - { - "$ref": "#/definitions/AWS::StepFunctions::Activity" - }, - { - "$ref": "#/definitions/AWS::StepFunctions::StateMachine" - }, - { - "$ref": "#/definitions/AWS::Synthetics::Canary" - }, - { - "$ref": "#/definitions/AWS::Timestream::Database" - }, - { - "$ref": "#/definitions/AWS::Timestream::Table" - }, - { - "$ref": "#/definitions/AWS::Transfer::Server" - }, - { - "$ref": "#/definitions/AWS::Transfer::User" - }, - { - "$ref": "#/definitions/AWS::WAF::ByteMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAF::IPSet" - }, - { - "$ref": "#/definitions/AWS::WAF::Rule" - }, - { - "$ref": "#/definitions/AWS::WAF::SizeConstraintSet" - }, - { - "$ref": "#/definitions/AWS::WAF::SqlInjectionMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAF::WebACL" - }, - { - "$ref": "#/definitions/AWS::WAF::XssMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::ByteMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::GeoMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::IPSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::RateBasedRule" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::RegexPatternSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::Rule" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::SizeConstraintSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::SqlInjectionMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::WebACL" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::WebACLAssociation" - }, - { - "$ref": "#/definitions/AWS::WAFRegional::XssMatchSet" - }, - { - "$ref": "#/definitions/AWS::WAFv2::IPSet" - }, - { - "$ref": "#/definitions/AWS::WAFv2::RegexPatternSet" - }, - { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup" - }, - { - "$ref": "#/definitions/AWS::WAFv2::WebACL" - }, - { - "$ref": "#/definitions/AWS::WAFv2::WebACLAssociation" - }, - { - "$ref": "#/definitions/AWS::WorkSpaces::ConnectionAlias" - }, - { - "$ref": "#/definitions/AWS::WorkSpaces::Workspace" - }, - { - "$ref": "#/definitions/Alexa::ASK::Skill" - } - ] - } - }, - "type": "object" - }, - "Transform": { - "oneOf": [ - { - "type": [ - "string" - ] - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ] - } - }, - "required": [ - "Resources" - ], - "type": "object" -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/chrome-manifest.json b/test/blackbox/docs/JsonSchemaDraft-4/chrome-manifest.json deleted file mode 100644 index 6d8885a89f..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/chrome-manifest.json +++ /dev/null @@ -1,758 +0,0 @@ -{ - "title": "JSON schema for Google Chrome extension manifest files", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "manifest_version", - "name", - "version" - ], - "properties": { - "manifest_version": { - "type": "number", - "description": "One integer specifying the version of the manifest file format your package requires.", - "enum": [ - 2 - ] - }, - "name": { - "type": "string", - "description": "The name of the extension", - "maxLength": 45 - }, - "version": { - "description": "One to four dot-separated integers identifying the version of this extension.", - "$ref": "#/definitions/version_string" - }, - "default_locale": { - "type": "string", - "description": "Specifies the subdirectory of _locales that contains the default strings for this extension.", - "default": "en" - }, - "description": { - "type": "string", - "description": "A plain text description of the extension", - "maxLength": 132 - }, - "icons": { - "type": "object", - "description": "One or more icons that represent the extension, app, or theme. Recommended format: PNG; also BMP, GIF, ICO, JPEG.", - "minProperties": 1, - "properties": { - "16": { - "$ref": "#/definitions/icon", - "description": "Used as the favicon for an extension's pages and infobar." - }, - "48": { - "$ref": "#/definitions/icon", - "description": "Used on the extension management page (chrome://extensions)." - }, - "128": { - "$ref": "#/definitions/icon", - "description": "Used during installation and in the Chrome Web Store." - }, - "256": { - "$ref": "#/definitions/icon", - "description": "Used during installation and in the Chrome Web Store." - } - } - }, - "browser_action": { - "$ref": "#/definitions/action", - "description": "Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup." - }, - "page_action": { - "$ref": "#/definitions/action", - "description": "Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages." - }, - "background": { - "type": "object", - "description": "The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.", - "properties": { - "persistent": { - "type": "boolean", - "description": "When false, makes the background page an event page (loaded only when needed).", - "default": true - }, - "page": { - "$ref": "#/definitions/page", - "description": "Specify the HTML of the background page.", - "default": "background.html" - }, - "scripts": { - "$ref": "#/definitions/scripts", - "description": "A background page will be generated by the extension system that includes each of the files listed in the scripts property.", - "default": [ - "background.js" - ] - } - }, - "dependencies": { - "page": { - "not": { - "required": [ - "scripts" - ] - } - }, - "scripts": { - "not": { - "required": [ - "page" - ] - } - } - } - }, - "chrome_url_overrides": { - "type": "object", - "description": "Override pages are a way to substitute an HTML file from your extension for a page that Google Chrome normally provides.", - "additionalProperties": false, - "maxProperties": 1, - "properties": { - "bookmarks": { - "$ref": "#/definitions/page", - "description": "The page that appears when the user chooses the Bookmark Manager menu item from the Chrome menu or, on Mac, the Bookmark Manager item from the Bookmarks menu. You can also get to this page by entering the URL chrome://bookmarks.", - "default": "bookmarks.html" - }, - "history": { - "$ref": "#/definitions/page", - "description": "The page that appears when the user chooses the History menu item from the Chrome menu or, on Mac, the Show Full History item from the History menu. You can also get to this page by entering the URL chrome://history.", - "default": "history.html" - }, - "newtab": { - "$ref": "#/definitions/page", - "description": "The page that appears when the user creates a new tab or window. You can also get to this page by entering the URL chrome://newtab.", - "default": "newtab.html" - } - } - }, - "commands": { - "type": "object", - "description": "Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.", - "patternProperties": { - ".*": { - "$ref": "#/definitions/command" - }, - "^_execute_browser_action$": { - "$ref": "#/definitions/command" - }, - "^_execute_page_action$": { - "$ref": "#/definitions/command" - } - } - }, - "content_scripts": { - "type": "array", - "description": "Content scripts are JavaScript files that run in the context of web pages.", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "object", - "required": [ - "matches" - ], - "additionalProperties": false, - "properties": { - "matches": { - "type": "array", - "description": "Specifies which pages this content script will be injected into.", - "minItems": 1, - "uniqueItems": true, - "items": { - "$ref": "#/definitions/match_pattern" - } - }, - "exclude_matches": { - "type": "array", - "description": "Excludes pages that this content script would otherwise be injected into.", - "uniqueItems": true, - "items": { - "$ref": "#/definitions/match_pattern" - } - }, - "css": { - "type": "array", - "description": "The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.", - "uniqueItems": true, - "items": { - "$ref": "#/definitions/uri" - } - }, - "js": { - "$ref": "#/definitions/scripts", - "description": "The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array." - }, - "run_at": { - "type": "string", - "description": "Controls when the files in js are injected.", - "enum": [ - "document_start", - "document_end", - "document_idle" - ], - "default": "document_idle" - }, - "all_frames": { - "type": "boolean", - "description": "Controls whether the content script runs in all frames of the matching page, or only the top frame.", - "default": false - }, - "include_globs": { - "type": "array", - "description": "Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.", - "uniqueItems": true, - "items": { - "$ref": "#/definitions/glob_pattern" - } - }, - "exclude_globs": { - "type": "array", - "description": "Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.", - "uniqueItems": true, - "items": { - "$ref": "#/definitions/glob_pattern" - } - }, - "match_about_blank": { - "type": "boolean", - "description": "Whether to insert the content script on about:blank and about:srcdoc.", - "default": false - } - } - } - }, - "content_security_policy": { - "$ref": "#/definitions/content_security_policy" - }, - "devtools_page": { - "$ref": "#/definitions/page", - "description": "A DevTools extension adds functionality to the Chrome DevTools. It can add new UI panels and sidebars, interact with the inspected page, get information about network requests, and more." - }, - "externally_connectable": { - "description": "Declares which extensions, apps, and web pages can connect to your extension via runtime.connect and runtime.sendMessage.", - "type": "object", - "additionalProperties": false, - "properties": { - "ids": { - "type": "array", - "items": { - "type": "string", - "description": "The IDs of extensions or apps that are allowed to connect. If left empty or unspecified, no extensions or apps can connect." - } - }, - "matches": { - "type": "array", - "items": { - "type": "string", - "description": "The URL patterns for web pages that are allowed to connect. This does not affect content scripts. If left empty or unspecified, no web pages can connect." - } - }, - "accepts_tls_channel_id": { - "type": "boolean", - "default": false, - "description": "Indicates that the extension would like to make use of the TLS channel ID of the web page connecting to it. The web page must also opt to send the TLS channel ID to the extension via setting includeTlsChannelId to true in runtime.connect's connectInfo or runtime.sendMessage's options." - } - } - }, - "file_browser_handlers": { - "type": "array", - "description": "You can use this API to enable users to upload files to your website.", - "minItems": 1, - "items": { - "type": "object", - "required": [ - "id", - "default_title", - "file_filters" - ], - "additionalProperties": false, - "properties": { - "id": { - "type": "string", - "description": "Used by event handling code to differentiate between multiple file handlers" - }, - "default_title": { - "type": "string", - "description": "What the button will display." - }, - "file_filters": { - "type": "array", - "description": "Filetypes to match.", - "minItems": 1, - "items": { - "type": "string" - } - } - } - } - }, - "homepage_url": { - "$ref": "#/definitions/uri", - "description": "The URL of the homepage for this extension." - }, - "incognito": { - "type": "string", - "description": "Specify how this extension will behave if allowed to run in incognito mode.", - "enum": [ - "spanning", - "split", - "not_allowed" - ], - "default": "spanning" - }, - "input_components": { - "type": "array", - "description": "Allows your extension to handle keystrokes, set the composition, and manage the candidate window.", - "items": { - "type": "object", - "required": [ - "name", - "type", - "id", - "description", - "language", - "layouts" - ], - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "description": { - "type": "string" - }, - "language": { - "type": "string" - }, - "layouts": { - "type": "array" - } - } - } - }, - "key": { - "type": "string", - "description": "This value can be used to control the unique ID of an extension, app, or theme when it is loaded during development." - }, - "minimum_chrome_version": { - "$ref": "#/definitions/version_string", - "description": "The version of Chrome that your extension, app, or theme requires, if any." - }, - "nacl_modules": { - "type": "array", - "description": "One or more mappings from MIME types to the Native Client module that handles each type.", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "object", - "required": [ - "path", - "mime_type" - ], - "additionalProperties": false, - "properties": { - "path": { - "$ref": "#/definitions/uri", - "description": "The location of a Native Client manifest (a .nmf file) within the extension directory." - }, - "mime_type": { - "$ref": "#/definitions/mime_type", - "description": "The MIME type for which the Native Client module will be registered as content handler." - } - } - } - }, - "oauth2": { - "type": "object", - "description": "Use the Chrome Identity API to authenticate users: the getAuthToken for users logged into their Google Account and the launchWebAuthFlow for users logged into a non-Google account.", - "required": [ - "client_id", - "scopes" - ], - "additionalProperties": false, - "properties": { - "client_id": { - "type": "string", - "description": "You need to register your app in the Google APIs Console to get the client ID." - }, - "scopes": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - } - } - }, - "offline_enabled": { - "type": "boolean", - "description": "Whether the app or extension is expected to work offline. When Chrome detects that it is offline, apps with this field set to true will be highlighted on the New Tab page." - }, - "omnibox": { - "type": "object", - "description": "The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.", - "required": [ - "keyword" - ], - "additionalProperties": false, - "properties": { - "keyword": { - "type": "string", - "description": "The keyword that will trigger your extension." - } - } - }, - "optional_permissions": { - "$ref": "#/definitions/permissions", - "description": "Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary." - }, - "options_page": { - "$ref": "#/definitions/page", - "description": "To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, a link to it will be provided from the extensions management page at chrome://extensions. Clicking the Options link opens a new tab pointing at your options page.", - "default": "options.html" - }, - "options_ui": { - "type": "object", - "description": "To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, an Options link will be shown on the extensions management page at chrome://extensions which opens a dialogue containing your options page.", - "required": [ - "page" - ], - "properties": { - "page": { - "type": "string", - "description": "The path to your options page, relative to your extension's root." - }, - "chrome_style": { - "type": "boolean", - "default": true, - "description": "If true, a Chrome user agent stylesheet will be applied to your options page. The default value is false, but we recommend you enable it for a consistent UI with Chrome." - }, - "open_in_tab": { - "type": "boolean", - "default": false, - "description": "If true, your extension's options page will be opened in a new tab rather than embedded in chrome://extensions. The default is false, and we recommend that you don't change it. This is only useful to delay the inevitable deprecation of the old options UI! It will be removed soon, so try not to use it. It will break." - } - } - }, - "permissions": { - "$ref": "#/definitions/permissions", - "description": "Permissions help to limit damage if your extension or app is compromised by malware. Some permissions are also displayed to users before installation, as detailed in Permission Warnings." - }, - "requirements": { - "type": "object", - "description": "Technologies required by the app or extension. Hosting sites such as the Chrome Web Store may use this list to dissuade users from installing apps or extensions that will not work on their computer.", - "additionalProperties": false, - "properties": { - "3D": { - "type": "object", - "description": "The '3D' requirement denotes GPU hardware acceleration.", - "required": [ - "features" - ], - "additionalProperties": false, - "properties": { - "features": { - "type": "array", - "description": "List of the 3D-related features your app requires.", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "webgl" - ] - } - } - } - }, - "plugins": { - "type": "object", - "description": "Indicates if an app or extension requires NPAPI to run. This requirement is enabled by default when the manifest includes the 'plugins' field.", - "required": [ - "npapi" - ], - "additionalProperties": false, - "properties": { - "npapi": { - "type": "boolean", - "default": true - } - } - } - } - }, - "sandbox": { - "type": "object", - "description": "Defines an collection of app or extension pages that are to be served in a sandboxed unique origin, and optionally a Content Security Policy to use with them.", - "required": [ - "pages" - ], - "additionalProperties": false, - "properties": { - "pages": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "$ref": "#/definitions/page" - } - }, - "content_security_policy": { - "$ref": "#/definitions/content_security_policy", - "default": "sandbox allow-scripts allow-forms" - } - } - }, - "short_name": { - "type": "string", - "description": "The short name is typically used where there is insufficient space to display the full name.", - "maxLength": 12 - }, - "update_url": { - "$ref": "#/definitions/uri", - "description": "If you publish using the Chrome Developer Dashboard, ignore this field. If you host your own extension or app: URL to an update manifest XML file." - }, - "tts_engine": { - "type": "object", - "description": "Register itself as a speech engine.", - "required": [ - "voices" - ], - "additionalProperties": false, - "properties": { - "voices": { - "type": "array", - "description": "Voices the extension can synthesize.", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "object", - "required": [ - "voice_name", - "event_types" - ], - "additionalProperties": false, - "properties": { - "voice_name": { - "type": "string", - "description": "Identifies the name of the voice and the engine used." - }, - "lang": { - "type": "string", - "description": "Almost always, a voice can synthesize speech in just a single language. When an engine supports more than one language, it can easily register a separate voice for each language." - }, - "gender": { - "type": "string", - "description": "If your voice corresponds to a male or female voice, you can use this parameter to help clients choose the most appropriate voice for their application." - }, - "event_types": { - "type": "array", - "description": "Events sent to update the client on the progress of speech synthesis.", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "string", - "description": "", - "enum": [ - "start", - "word", - "sentence", - "marker", - "end", - "error" - ] - } - } - } - } - } - } - }, - "version_name": { - "type": "string", - "description": "In addition to the version field, which is used for update purposes, version_name can be set to a descriptive version string and will be used for display purposes if present." - }, - "web_accessible_resources": { - "type": "array", - "description": "An array of strings specifying the paths (relative to the package root) of packaged resources that are expected to be usable in the context of a web page.", - "minItems": 1, - "uniqueItems": true, - "items": { - "$ref": "#/definitions/uri" - } - }, - "chrome_settings_overrides": {}, - "content_pack": {}, - "current_locale": {}, - "import": {}, - "platforms": {}, - "signature": {}, - "spellcheck": {}, - "storage": {}, - "system_indicator": {} - }, - "dependencies": { - "page_action": { - "not": { - "required": [ - "browser_action" - ] - } - }, - "browser_action": { - "not": { - "required": [ - "page_action" - ] - } - }, - "content_scripts": { - "not": { - "required": [ - "script_badge" - ] - } - }, - "script_badge": { - "not": { - "required": [ - "content_scripts" - ] - } - } - }, - "definitions": { - "action": { - "type": "object", - "properties": { - "default_title": { - "type": "string", - "description": "Tooltip for the main toolbar icon." - }, - "default_popup": { - "$ref": "#/definitions/uri", - "description": "The popup appears when the user clicks the icon." - }, - "default_icon": { - "anyOf": [ - { - "type": "string", - "description": "FIXME: String form is deprecated." - }, - { - "type": "object", - "description": "Icon for the main toolbar.", - "properties": { - "19": { - "$ref": "#/definitions/icon" - }, - "38": { - "$ref": "#/definitions/icon" - } - } - } - ] - } - }, - "dependencies": { - "name": { - "not": { - "required": [ - "name" - ] - } - }, - "icons": { - "not": { - "required": [ - "icons" - ] - } - }, - "popup": { - "not": { - "required": [ - "popup" - ] - } - } - } - }, - "command": { - "type": "object", - "additionalProperties": false, - "properties": { - "description": { - "type": "string" - }, - "suggested_key": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^(default|mac|windows|linux|chromeos)$": { - "type": "string", - "pattern": "^(Ctrl|Command|MacCtrl|Alt|Option)\\+(Shift\\+)?[A-Z]" - } - } - } - } - }, - "content_security_policy": { - "type": "string", - "description": "This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.", - "format": "content-security-policy", - "default": "script-src 'self'; object-src 'self'" - }, - "glob_pattern": { - "type": "string", - "format": "glob-pattern" - }, - "icon": { - "$ref": "#/definitions/uri" - }, - "match_pattern": { - "type": "string", - "format": "match-pattern", - "pattern": "^((\\*|http|https|file|ftp|chrome-extension):\\/\\/(\\*|\\*\\.[^\\/\\*]+|[^\\/\\*]+)?(\\/.*))|$" - }, - "mime_type": { - "type": "string", - "format": "mime-type", - "pattern": "^(?:application|audio|image|message|model|multipart|text|video)\\/[-+.\\w]+$" - }, - "page": { - "$ref": "#/definitions/uri" - }, - "permissions": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "format": "permission" - } - }, - "scripts": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "$ref": "#/definitions/uri" - } - }, - "uri": { - "type": "string" - }, - "version_string": { - "type": "string", - "pattern": "^(?:\\d{1,5}\\.){0,3}\\d{1,5}$" - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/circleci-config.json b/test/blackbox/docs/JsonSchemaDraft-4/circleci-config.json deleted file mode 100644 index 68985aacce..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/circleci-config.json +++ /dev/null @@ -1,1317 +0,0 @@ -{ - "title": "JSON schema for CircleCI configuration files", - "$schema": "http://json-schema.org/draft-04/schema#", - "definitions": { - "logical": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nA logical statement to be used in dynamic configuration", - "oneOf": [ - { - "type": [ - "string", - "boolean", - "integer", - "number" - ] - }, - { - "type": "object", - "additionalProperties": false, - "minProperties": 1, - "maxProperties": 1, - "properties": { - "and": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nLogical and: true when all statements in the list are true", - "type": "array", - "items": { - "$ref": "#/definitions/logical" - } - }, - "or": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nLogical or: true when at least one statements in the list is true", - "type": "array", - "items": { - "$ref": "#/definitions/logical" - } - }, - "not": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nLogical not: true when statement is false", - "$ref": "#/definitions/logical" - }, - "equal": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nTrue when all elements in the list are equal", - "type": "array" - }, - "matches": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#logic-statements \n\nTrue when value matches the pattern", - "type": "object", - "additionalProperties": false, - "properties": { - "pattern": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - } - } - ] - }, - "filter": { - "description": "A map defining rules for execution on specific branches", - "type": "object", - "additionalProperties": false, - "properties": { - "only": { - "description": "Either a single branch specifier, or a list of branch specifiers", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "ignore": { - "description": "Either a single branch specifier, or a list of branch specifiers", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - }, - "orbs": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#orbs-requires-version-21\n\nOrbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.", - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "description": "https://circleci.com/docs/2.0/creating-orbs/#semantic-versioning-in-orbs\n\nAn orb to depend on and its semver range, or volatile for the most recent release.", - "type": "string", - "pattern": "^[a-z][a-z0-9_-]+/[a-z][a-z0-9_-]+@(\\d+|\\d+\\.\\d+|\\d+\\.\\d+\\.\\d+|volatile)$" - }, - { - "description": "https://circleci.com/docs/2.0/creating-orbs/#creating-inline-orbs\n\nInline orbs can be handy during development of an orb or as a convenience for name-spacing jobs and commands in lengthy configurations, particularly if you later intend to share the orb with others.", - "type": "object", - "properties": { - "orbs": { - "$ref": "#/definitions/orbs" - }, - "commands": { - "$ref": "#/definitions/commands" - }, - "executors": { - "$ref": "#/definitions/executors" - }, - "jobs": { - "$ref": "#/definitions/jobs" - } - } - } - ] - } - }, - "commands": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#commands-requires-version-21\n\nA command definition defines a sequence of steps as a map to be executed in a job, enabling you to reuse a single command definition across multiple jobs.", - "type": "object", - "additionalProperties": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#commands-requires-version-21\n\nDefinition of a custom command.", - "type": "object", - "required": [ - "steps" - ], - "properties": { - "steps": { - "description": "A sequence of steps run inside the calling job of the command.", - "type": "array", - "items": { - "$ref": "#/definitions/step" - } - }, - "parameters": { - "description": "https://circleci.com/docs/2.0/reusing-config/#using-the-parameters-declaration\n\nA map of parameter keys.", - "type": "object", - "patternProperties": { - "^[a-z][a-z0-9_-]+$": { - "oneOf": [ - { - "description": "https://circleci.com/docs/2.0/reusing-config/#string\n\nA string parameter.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "string" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "string" - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#boolean\n\nA boolean parameter.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "boolean" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "boolean" - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#integer\n\nAn integer parameter.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "integer" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "integer" - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#enum\n\nThe `enum` parameter may be a list of any values. Use the `enum` parameter type when you want to enforce that the value must be one from a specific set of string values.", - "type": "object", - "required": [ - "type", - "enum" - ], - "properties": { - "type": { - "enum": [ - "enum" - ] - }, - "enum": { - "type": "array", - "minItems": 1, - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - }, - "default": { - "type": "string" - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#executor\n\nUse an `executor` parameter type to allow the invoker of a job to decide what executor it will run on.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "executor" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "string" - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#steps\n\nSteps are used when you have a job or command that needs to mix predefined and user-defined steps. When passed in to a command or job invocation, the steps passed as parameters are always defined as a sequence, even if only one step is provided.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "steps" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "array", - "items": { - "$ref": "#/definitions/step" - } - } - } - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#environment-variable-name\n\nThe environment variable name parameter is a string that must match a POSIX_NAME regexp (e.g. no spaces or special characters) and is a more meaningful parameter type that enables additional checks to be performed. ", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "enum": [ - "env_var_name" - ] - }, - "description": { - "type": "string" - }, - "default": { - "type": "string", - "pattern": "^[a-zA-Z][a-zA-Z0-9_-]+$" - } - } - } - ] - } - } - }, - "description": { - "description": "A string that describes the purpose of the command.", - "type": "string" - } - } - } - }, - "dockerExecutor": { - "description": "Options for the [docker executor](https://circleci.com/docs/2.0/configuration-reference/#docker)", - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "image" - ], - "properties": { - "image": { - "description": "The name of a custom docker image to use", - "type": "string" - }, - "name": { - "description": "The name the container is reachable by. By default, container services are accessible through `localhost`", - "type": "string" - }, - "entrypoint": { - "description": "The command used as executable when launching the container", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "command": { - "description": "The command used as pid 1 (or args for entrypoint) when launching the container", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "user": { - "description": "Which user to run the command as", - "type": "string" - }, - "environment": { - "description": "A map of environment variable names and values", - "type": "object", - "additionalProperties": { - "type": [ - "string", - "number" - ] - } - }, - "auth": { - "description": "Authentication for registries using standard `docker login` credentials", - "type": "object", - "additionalProperties": false, - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "aws_auth": { - "description": "Authentication for AWS EC2 Container Registry (ECR)", - "type": "object", - "additionalProperties": false, - "properties": { - "aws_access_key_id": { - "type": "string" - }, - "aws_secret_access_key": { - "type": "string" - } - } - } - } - } - }, - "machineExecutor": { - "description": "Options for the [machine executor](https://circleci.com/docs/2.0/configuration-reference/#machine)", - "type": "object", - "required": [ - "image" - ], - "additionalProperties": false, - "properties": { - "image": { - "description": "The VM image to use. View [available images](https://circleci.com/docs/2.0/configuration-reference/#available-machine-images). **Note:** This key is **not** supported on the installable CircleCI. For information about customizing machine executor images on CircleCI installed on your servers, see our [VM Service documentation](https://circleci.com/docs/2.0/vm-service).", - "type": "string", - "default": "ubuntu-1604:202004-01" - }, - "docker_layer_caching": { - "description": "Set to `true` to enable [Docker Layer Caching](https://circleci.com/docs/2.0/docker-layer-caching). Note: You must open a support ticket to have a CircleCI Sales representative contact you about enabling this feature on your account for an additional fee.", - "type": "boolean", - "default": "true" - } - } - }, - "macosExecutor": { - "description": "Options for the [macOS executor](https://circleci.com/docs/2.0/configuration-reference/#macos)", - "type": "object", - "additionalProperties": false, - "required": [ - "xcode" - ], - "properties": { - "xcode": { - "description": "The version of Xcode that is installed on the virtual machine, see the [Supported Xcode Versions section of the Testing iOS](https://circleci.com/docs/2.0/testing-ios/#supported-xcode-versions) document for the complete list.", - "type": "string" - } - } - }, - "executorChoice": { - "oneOf": [ - { - "type": "object", - "required": [ - "docker" - ], - "properties": { - "docker": { - "$ref": "#/definitions/dockerExecutor" - } - } - }, - { - "type": "object", - "required": [ - "machine" - ], - "properties": { - "machine": { - "$ref": "#/definitions/machineExecutor" - } - } - }, - { - "type": "object", - "required": [ - "machine" - ], - "properties": { - "machine": { - "description": "Use the default machine executor image", - "type": "boolean" - } - } - }, - { - "type": "object", - "required": [ - "macos" - ], - "properties": { - "macos": { - "$ref": "#/definitions/macosExecutor" - } - } - } - ] - }, - "executors": { - "description": "Executors define the environment in which the steps of a job will be run, allowing you to reuse a single executor definition across multiple jobs.", - "type": "object", - "additionalProperties": { - "type": "object", - "$ref": "#/definitions/executorChoice", - "properties": { - "resource_class": { - "description": "Amount of CPU and RAM allocated to each container in a job. Note: A performance plan is required to access this feature.", - "type": "string", - "default": "medium", - "enum": [ - "small", - "medium", - "medium+", - "large", - "xlarge", - "2xlarge", - "2xlarge+", - "gpu.nvidia.small", - "gpu.nvidia.medium", - "windows.gpu.nvidia.medium" - ] - }, - "shell": { - "description": "Shell to use for execution command in all steps. Can be overridden by shell in each step (default: See [Default Shell Options](https://circleci.com/docs/2.0/configuration-reference/#default-shell-options)", - "type": "string" - }, - "working_directory": { - "description": "In which directory to run the steps.", - "type": "string" - }, - "environment": { - "description": "A map of environment variable names and values.", - "type": "object", - "additionalProperties": { - "type": [ - "string", - "number" - ] - } - } - } - } - }, - "builtinSteps": { - "documentation": { - "run": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#run\n\nUsed for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the `command` and `name`. Run commands are executed using non-login shells by default, so you must explicitly source any dotfiles as part of the command." - }, - "checkout": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#checkout\n\nSpecial step used to check out source code to the configured `path` (defaults to the `working_directory`). The reason this is a special step is because it is more of a helper function designed to make checking out code easy for you. If you require doing git over HTTPS you should not use this step as it configures git to checkout over ssh." - }, - "setup_remote_docker": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#setup_remote_docker\n\nCreates a remote Docker environment configured to execute Docker commands." - }, - "save_cache": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#save_cache\n\nGenerates and stores a cache of a file or directory of files such as dependencies or source code in our object storage. Later jobs can restore this cache using the `restore_cache` step." - }, - "restore_cache": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#restore_cache\n\nRestores a previously saved cache based on a `key`. Cache needs to have been saved first for this key using the `save_cache` step." - }, - "deploy": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#deploy\n\nSpecial step for deploying artifacts. `deploy` uses the same configuration map and semantics as run step. Jobs may have more than one deploy step. In general deploy step behaves just like run with two exceptions:\n* In a job with parallelism, the deploy step will only be executed by node #0 and only if all nodes succeed. Nodes other than #0 will skip this step.\n* In a job that runs with SSH, the deploy step will not execute" - }, - "store_artifacts": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#store_artifacts\n\nStep to store artifacts (for example logs, binaries, etc) to be available in the web app or through the API." - }, - "store_test_results": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#store_test_results\n\nSpecial step used to upload test results so they display in builds’ Test Summary section and can be used for timing analysis. To also see test result as build artifacts, please use the `store_artifacts` step." - }, - "persist_to_workspace": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#persist_to_workspace\n\nSpecial step used to persist a temporary file to be used by another job in the workflow" - }, - "attach_workspace": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#attach_workspace\n\nSpecial step used to attach the workflow's workspace to the current container. The full contents of the workspace are downloaded and copied into the directory the workspace is being attached at." - }, - "add_ssh_keys": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#add_ssh_keys\n\nSpecial step that adds SSH keys from a project’s settings to a container. Also configures SSH to use these keys." - }, - "when": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#the-when-step-requires-version-21 \n\nConditional step to run on custom conditions (determined at config-compile time) that are checked before a workflow runs" - }, - "unless": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#the-when-step-requires-version-21 \n\nConditional step to run when custom conditions aren't met (determined at config-compile time) that are checked before a workflow runs" - } - }, - "configuration": { - "run": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/run" - } - ], - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "command" - ], - "properties": { - "command": { - "description": "Command to run via the shell", - "type": "string" - }, - "name": { - "description": "Title of the step to be shown in the CircleCI UI (default: full `command`)", - "type": "string" - }, - "shell": { - "description": "Shell to use for execution command", - "type": "string" - }, - "environment": { - "description": "Additional environmental variables, locally scoped to command", - "type": "object", - "additionalProperties": { - "type": [ - "string", - "number" - ] - } - }, - "background": { - "description": "Whether or not this step should run in the background (default: false)", - "default": false, - "type": "boolean" - }, - "working_directory": { - "description": "In which directory to run this step (default: `working_directory` of the job", - "type": "string" - }, - "no_output_timeout": { - "description": "Elapsed time the command can run without output. The string is a decimal with unit suffix, such as \"20m\", \"1.25h\", \"5s\" (default: 10 minutes)", - "type": "string", - "pattern": "\\d+(\\.\\d+)?[mhs]", - "default": "10m" - }, - "when": { - "description": "Specify when to enable or disable the step. Takes the following values: `always`, `on_success`, `on_fail` (default: `on_success`)", - "enum": [ - "always", - "on_success", - "on_fail" - ] - } - } - } - ] - }, - "checkout": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/checkout" - } - ], - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "path": { - "description": "Checkout directory (default: job’s `working_directory`)", - "type": "string" - } - } - }, - "setup_remote_docker": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/setup_remote_docker" - } - ], - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "docker_layer_caching": { - "description": "When `docker_layer_caching` is set to `true`, CircleCI will try to reuse Docker Images (layers) built during a previous job or workflow (Paid feature)", - "type": "boolean", - "default": false - }, - "version": { - "description": "If your build requires a specific docker image, you can set it as an image attribute", - "enum": [ - "20.10.6", - "20.10.2", - "19.03.14", - "19.03.13", - "19.03.12", - "19.03.8", - "18.09.3", - "17.09.0-ce" - ], - "default": "19.03.13" - } - } - }, - "save_cache": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/save_cache" - } - ], - "type": "object", - "additionalProperties": false, - "required": [ - "paths", - "key" - ], - "properties": { - "paths": { - "description": "List of directories which should be added to the cache", - "type": "array", - "items": { - "type": "string" - } - }, - "key": { - "description": "Unique identifier for this cache", - "type": "string" - }, - "name": { - "type": "string", - "description": "Title of the step to be shown in the CircleCI UI (default: 'Saving Cache')" - }, - "when": { - "description": "Specify when to enable or disable the step. Takes the following values: `always`, `on_success`, `on_fail` (default: `on_success`)", - "enum": [ - "always", - "on_success", - "on_fail" - ] - } - } - }, - "restore_cache": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/restore_cache" - } - ], - "oneOf": [ - { - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "Single cache key to restore" - }, - "name": { - "type": "string", - "description": "Title of the step to be shown in the CircleCI UI (default: 'Restoring Cache')" - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": [ - "keys" - ], - "properties": { - "name": { - "type": "string", - "description": "Title of the step to be shown in the CircleCI UI (default: 'Restoring Cache')" - }, - "keys": { - "description": "List of cache keys to lookup for a cache to restore. Only first existing key will be restored.", - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - }, - "deploy": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/deploy" - }, - { - "$ref": "#/definitions/builtinSteps/configuration/run" - } - ] - }, - "store_artifacts": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/store_artifacts" - } - ], - "type": "object", - "additionalProperties": false, - "required": [ - "path" - ], - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "path": { - "description": "Directory in the primary container to save as job artifacts", - "type": "string" - }, - "destination": { - "description": "Prefix added to the artifact paths in the artifacts API (default: the directory of the file specified in `path`)", - "type": "string" - } - } - }, - "store_test_results": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/store_test_results" - } - ], - "type": "object", - "additionalProperties": false, - "required": [ - "path" - ], - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "path": { - "description": "Path (absolute, or relative to your `working_directory`) to directory containing subdirectories of JUnit XML or Cucumber JSON test metadata files", - "type": "string" - } - } - }, - "persist_to_workspace": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/persist_to_workspace" - } - ], - "type": "object", - "additionalProperties": false, - "required": [ - "root", - "paths" - ], - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "root": { - "description": "Either an absolute path or a path relative to `working_directory`", - "type": "string" - }, - "paths": { - "description": "Glob identifying file(s), or a non-glob path to a directory to add to the shared workspace. Interpreted as relative to the workspace root. Must not be the workspace root itself.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "attach_workspace": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/attach_workspace" - } - ], - "type": "object", - "additionalProperties": false, - "required": [ - "at" - ], - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "at": { - "description": "Directory to attach the workspace to", - "type": "string" - } - } - }, - "add_ssh_keys": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/add_ssh_keys" - } - ], - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "Title of the step to be shown in the CircleCI UI", - "type": "string" - }, - "fingerprints": { - "description": "Directory to attach the workspace to", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "when": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/when" - } - ], - "type": "object", - "additionalProperties": false, - "properties": { - "condition": { - "$ref": "#/definitions/logical" - }, - "steps": { - "description": "A list of steps to be performed", - "type": "array", - "items": { - "$ref": "#/definitions/step" - } - } - }, - "required": [ - "condition", - "steps" - ] - }, - "unless": { - "allOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/unless" - } - ], - "type": "object", - "additionalProperties": false, - "properties": { - "condition": { - "$ref": "#/definitions/logical" - }, - "steps": { - "description": "A list of steps to be performed", - "type": "array", - "items": { - "$ref": "#/definitions/step" - } - } - }, - "required": [ - "condition", - "steps" - ] - } - } - }, - "step": { - "anyOf": [ - { - "$ref": "#/definitions/builtinSteps/documentation/checkout", - "enum": [ - "checkout" - ] - }, - { - "$ref": "#/definitions/builtinSteps/documentation/setup_remote_docker", - "enum": [ - "setup_remote_docker" - ] - }, - { - "$ref": "#/definitions/builtinSteps/documentation/add_ssh_keys", - "enum": [ - "add_ssh_keys" - ] - }, - { - "description": "https://circleci.com/docs/2.0/reusing-config/#invoking-reusable-commands\n\nA custom command defined via the top level commands key", - "type": "string", - "pattern": "^[a-z][a-z0-9_-]+$" - }, - { - "description": "https://circleci.com/docs/2.0/using-orbs/#commands\n\nA custom command defined via an orb.", - "type": "string", - "pattern": "^[a-z][a-z0-9_-]+/[a-z][a-z0-9_-]+$" - }, - { - "type": "object", - "minProperties": 1, - "maxProperties": 1, - "properties": { - "run": { - "$ref": "#/definitions/builtinSteps/configuration/run" - }, - "checkout": { - "$ref": "#/definitions/builtinSteps/configuration/checkout" - }, - "setup_remote_docker": { - "$ref": "#/definitions/builtinSteps/configuration/setup_remote_docker" - }, - "save_cache": { - "$ref": "#/definitions/builtinSteps/configuration/save_cache" - }, - "restore_cache": { - "$ref": "#/definitions/builtinSteps/configuration/restore_cache" - }, - "deploy": { - "$ref": "#/definitions/builtinSteps/configuration/deploy" - }, - "store_artifacts": { - "$ref": "#/definitions/builtinSteps/configuration/store_artifacts" - }, - "store_test_results": { - "$ref": "#/definitions/builtinSteps/configuration/store_test_results" - }, - "persist_to_workspace": { - "$ref": "#/definitions/builtinSteps/configuration/persist_to_workspace" - }, - "attach_workspace": { - "$ref": "#/definitions/builtinSteps/configuration/attach_workspace" - }, - "add_ssh_keys": { - "$ref": "#/definitions/builtinSteps/configuration/add_ssh_keys" - }, - "when": { - "$ref": "#/definitions/builtinSteps/configuration/when" - }, - "unless": { - "$ref": "#/definitions/builtinSteps/configuration/unless" - } - }, - "patternProperties": { - "^[a-z][a-z0-9_-]+$": { - "description": "https://circleci.com/docs/2.0/reusing-config/#invoking-reusable-commands\n\nA custom command defined via the top level commands key" - }, - "^[a-z][a-z0-9_-]+/[a-z][a-z0-9_-]+$": { - "description": "https://circleci.com/docs/2.0/using-orbs/#commands\n\nA custom command defined via an orb." - } - } - } - ] - }, - "jobRef": { - "description": "Run a job as part of this workflow", - "type": "object", - "additionalProperties": true, - "properties": { - "requires": { - "description": "Jobs are run in parallel by default, so you must explicitly require any dependencies by their job name.", - "type": "array", - "items": { - "type": "string" - } - }, - "context": { - "description": "Either a single context name, or a list of contexts. The default name is `org-global`", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "default": "org-global" - }, - "type": { - "description": "A job may have a `type` of `approval` indicating it must be manually approved before downstream jobs may proceed.", - "enum": [ - "approval" - ] - }, - "filters": { - "description": "A map defining rules for execution on specific branches", - "type": "object", - "additionalProperties": false, - "properties": { - "branches": { - "$ref": "#/definitions/filter" - }, - "tags": { - "$ref": "#/definitions/filter" - } - } - }, - "matrix": { - "description": "https://circleci.com/docs/2.0/configuration-reference/#matrix-requires-version-21\n\nThe matrix stanza allows you to run a parameterized job multiple times with different arguments.", - "type": "object", - "additionalProperties": false, - "required": [ - "parameters" - ], - "properties": { - "parameters": { - "description": "A map of parameter names to every value the job should be called with", - "type": "object", - "additionalProperties": { - "type": "array" - } - }, - "exclude": { - "description": "A list of argument maps that should be excluded from the matrix", - "type": "array", - "items": { - "type": "object" - } - }, - "alias": { - "description": "An alias for the matrix, usable from another job’s requires stanza. Defaults to the name of the job being executed", - "type": "string" - } - } - } - } - }, - "jobs": { - "type": "object", - "additionalProperties": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/executorChoice" - }, - { - "type": "object", - "required": [ - "executor" - ], - "properties": { - "executor": { - "description": "The name of the executor to use (defined via the top level executors map).", - "type": "string" - } - } - }, - { - "type": "object", - "required": [ - "executor" - ], - "properties": { - "executor": { - "description": "Executor stanza to use for the job", - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "description": "The name of the executor to use (defined via the top level executors map).", - "type": "string" - } - } - } - } - } - ], - "required": [ - "steps" - ], - "properties": { - "shell": { - "description": "Shell to use for execution command in all steps. Can be overridden by shell in each step", - "type": "string" - }, - "steps": { - "description": "A list of steps to be performed", - "type": "array", - "items": { - "$ref": "#/definitions/step" - } - }, - "working_directory": { - "description": "In which directory to run the steps. (default: `~/project`. `project` is a literal string, not the name of the project.) You can also refer the directory with `$CIRCLE_WORKING_DIRECTORY` environment variable.", - "type": "string", - "default": "~/project" - }, - "parallelism": { - "description": "Number of parallel instances of this job to run (default: 1)", - "default": 1, - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string", - "pattern": "^<<.+\\..+>>$" - } - ] - }, - "environment": { - "description": "A map of environment variable names and variables (NOTE: these will override any environment variables you set in the CircleCI web interface).", - "type": "object", - "additionalProperties": { - "type": [ - "string", - "number" - ] - } - }, - "branches": { - "description": "A map defining rules for whitelisting/blacklisting execution of specific branches for a single job that is **not** in a workflow (default: all whitelisted). See Workflows for configuring branch execution for jobs in a workflow.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - } - }, - "type": "object", - "required": [ - "version" - ], - "properties": { - "version": { - "description": "The version field is intended to be used in order to issue warnings for deprecation or breaking changes.", - "default": 2.1, - "enum": [ - 2, - 2.1 - ] - }, - "orbs": { - "$ref": "#/definitions/orbs" - }, - "commands": { - "$ref": "#/definitions/commands" - }, - "executors": { - "$ref": "#/definitions/executors" - }, - "jobs": { - "$ref": "#/definitions/jobs" - }, - "workflows": { - "description": "Used for orchestrating all jobs. Each workflow consists of the workflow name as a key and a map as a value", - "type": "object", - "properties": { - "version": { - "description": "The Workflows `version` field is used to issue warnings for deprecation or breaking changes during v2 Beta. It is deprecated as of CircleCI v2.1", - "enum": [ - 2 - ] - } - }, - "additionalProperties": { - "type": "object", - "additionalProperties": false, - "properties": { - "triggers": { - "description": "Specifies which triggers will cause this workflow to be executed. Default behavior is to trigger the workflow when pushing to a branch.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "schedule": { - "description": "A workflow may have a schedule indicating it runs at a certain time, for example a nightly build that runs every day at 12am UTC:", - "type": "object", - "properties": { - "cron": { - "description": "See the [crontab man page](http://pubs.opengroup.org/onlinepubs/7908799/xcu/crontab.html)", - "type": "string" - }, - "filters": { - "description": "A map defining rules for execution on specific branches", - "type": "object", - "additionalProperties": false, - "properties": { - "branches": { - "$ref": "#/definitions/filter" - } - } - } - } - } - } - } - }, - "jobs": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": { - "type": "object", - "$ref": "#/definitions/jobRef" - } - } - ] - } - }, - "when": { - "description": "Specify when to run the workflow.", - "$ref": "#/definitions/logical" - }, - "unless": { - "description": "Specify when *not* to run the workflow.", - "$ref": "#/definitions/logical" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/draft-4-core.json b/test/blackbox/docs/JsonSchemaDraft-4/draft-4-core.json deleted file mode 100644 index bcbb84743e..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/draft-4-core.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "id": "http://json-schema.org/draft-04/schema#", - "$schema": "http://json-schema.org/draft-04/schema#", - "description": "Core schema meta-schema", - "definitions": { - "schemaArray": { - "type": "array", - "minItems": 1, - "items": { "$ref": "#" } - }, - "positiveInteger": { - "type": "integer", - "minimum": 0 - }, - "positiveIntegerDefault0": { - "allOf": [ { "$ref": "#/definitions/positiveInteger" }, { "default": 0 } ] - }, - "simpleTypes": { - "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ] - }, - "stringArray": { - "type": "array", - "items": { "type": "string" }, - "minItems": 1, - "uniqueItems": true - } - }, - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "$schema": { - "type": "string" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default": {}, - "multipleOf": { - "type": "number", - "minimum": 0, - "exclusiveMinimum": true - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "boolean", - "default": false - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "boolean", - "default": false - }, - "maxLength": { "$ref": "#/definitions/positiveInteger" }, - "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" }, - "pattern": { - "type": "string", - "format": "regex" - }, - "additionalItems": { - "anyOf": [ - { "type": "boolean" }, - { "$ref": "#" } - ], - "default": {} - }, - "items": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/schemaArray" } - ], - "default": {} - }, - "maxItems": { "$ref": "#/definitions/positiveInteger" }, - "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "maxProperties": { "$ref": "#/definitions/positiveInteger" }, - "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" }, - "required": { "$ref": "#/definitions/stringArray" }, - "additionalProperties": { - "anyOf": [ - { "type": "boolean" }, - { "$ref": "#" } - ], - "default": {} - }, - "definitions": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "properties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "dependencies": { - "type": "object", - "additionalProperties": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/stringArray" } - ] - } - }, - "enum": { - "type": "array", - "minItems": 1, - "uniqueItems": true - }, - "type": { - "anyOf": [ - { "$ref": "#/definitions/simpleTypes" }, - { - "type": "array", - "items": { "$ref": "#/definitions/simpleTypes" }, - "minItems": 1, - "uniqueItems": true - } - ] - }, - "format": { "type": "string" }, - "allOf": { "$ref": "#/definitions/schemaArray" }, - "anyOf": { "$ref": "#/definitions/schemaArray" }, - "oneOf": { "$ref": "#/definitions/schemaArray" }, - "not": { "$ref": "#" } - }, - "dependencies": { - "exclusiveMaximum": [ "maximum" ], - "exclusiveMinimum": [ "minimum" ] - }, - "default": {} -} diff --git a/test/blackbox/docs/JsonSchemaDraft-4/grafana-dashboard-5.json b/test/blackbox/docs/JsonSchemaDraft-4/grafana-dashboard-5.json deleted file mode 100644 index f99459d898..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/grafana-dashboard-5.json +++ /dev/null @@ -1,264 +0,0 @@ -{ - "description": "JSON Schema for Grafana 5.x Dashboards (https://grafana.com/docs/grafana/latest/reference/dashboard/#dashboard-json)", - "title": "Grafana Dashboard 5.x", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "meta": { - "type": "object", - "properties": { - "isStarred": { - "type": "boolean" - } - } - }, - "dashboard": { - "type": "object", - "properties": { - "id": { - "description": "unique numeric identifier for the dashboard. (generated by the db)", - "type": [ - "number", - "null" - ] - }, - "uid": { - "description": "unique dashboard identifier that can be generated by anyone. string (8-40)", - "type": "string", - "minLength": 8, - "maxLength": 40 - }, - "title": { - "description": "current title of dashboard", - "type": "string" - }, - "tags": { - "description": "tags associated with dashboard, an array of strings", - "type": "array", - "items": { - "type": "string" - } - }, - "style": { - "description": "theme of dashboard, i.e. dark or light", - "type": "string" - }, - "timezone": { - "description": "timezone of dashboard, i.e. utc or browser", - "type": "string" - }, - "editable": { - "description": "whether a dashboard is editable or not", - "type": "boolean" - }, - "hideControls": { - "type": "boolean" - }, - "graphTooltip": { - "description": "0 for no shared crosshair or tooltip (default), 1 for shared crosshair, 2 for shared crosshair AND shared tooltip", - "type": "number", - "minimum": 0, - "maximum": 2 - }, - "panels": { - "description": "Panels are the building blocks of a dashboard. It consists of data source queries, type of graphs, aliases, etc. Panel JSON consists of an array of JSON objects, each representing a different panel. Most of the fields are common for all panels but some fields depend on the panel type.", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "title": { - "type": "string" - }, - "gridPos": { - "description": "The gridPos property describes the panel size and position in grid coordinates.", - "type": "object", - "properties": { - "x": { - "description": "The x position, in same unit as w.", - "type": "number" - }, - "y": { - "description": "The y position, in same unit as h.", - "type": "number" - }, - "w": { - "description": "1-24 (the width of the dashboard is divided into 24 columns)", - "type": "number", - "minimum": 1, - "maximum": 24 - }, - "h": { - "description": "In grid height units, each represents 30 pixels.", - "type": "number" - } - } - }, - "id": { - "type": "number" - }, - "mode": { - "type": "string" - }, - "content": { - "type": "string" - } - } - } - }, - "time": { - "description": "time range for dashboard, i.e. last 6 hours, last 7 days, etc" - }, - "timepicker": { - "description": "timepicker metadata", - "type": "object", - "properties": { - "collapse": { - "description": "whether timepicker is collapsed or not", - "type": "boolean" - }, - "enable": { - "description": "whether timepicker is enabled or not", - "type": "boolean" - }, - "notice": { - "type": "boolean" - }, - "now": { - "type": "boolean" - }, - "refresh_intervals": { - "type": "array", - "items": { - "type": "string" - } - }, - "status": { - "type": "string" - }, - "type": { - "type": "string" - } - } - }, - "templating": { - "description": "templating metadata", - "type": "object", - "properties": { - "enable": { - "description": "whether templating is enabled or not", - "type": "boolean" - }, - "list": { - "description": "an array of objects each representing one template variable", - "type": "array", - "items": { - "type": "object", - "properties": { - "allFormat": { - "description": "format to use while fetching all values from data source, eg: wildcard, glob, regex, pipe, etc.", - "type": "string" - }, - "current": { - "description": "shows current selected variable text/value on the dashboard", - "type": "object", - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "text": { - "type": "string" - }, - "value": { - "type": "string" - } - } - }, - "datasource": { - "description": "shows data source for the variables", - "type": [ - "string", - "null" - ] - }, - "includeAll": { - "description": "whether all value option is available or not", - "type": "boolean" - }, - "multi": { - "description": "whether multiple values can be selected or not from variable value list", - "type": "boolean" - }, - "multiFormat": { - "description": "format to use while fetching timeseries from data source", - "type": "string" - }, - "name": { - "description": "name of variable", - "type": "string" - }, - "options": { - "description": "array of variable text/value pairs available for selection on dashboard", - "type": "array", - "items": { - "type": "object", - "properties": { - "selected": { - "type": "boolean" - }, - "text": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - }, - "query": { - "description": "data source query used to fetch values for a variable", - "type": "string" - }, - "refresh": { - "type": "boolean" - }, - "regex": { - "type": "string" - }, - "type": { - "description": "type of variable, i.e. custom, query or interval", - "type": "string" - } - } - } - } - } - }, - "annotations": { - "description": "annotations metadata" - }, - "refresh": { - "description": "auto-refresh interval" - }, - "schemaVersion": { - "description": "version of the JSON schema (integer), incremented each time a Grafana update brings changes to said schema", - "type": "number" - }, - "version": { - "description": "version of the dashboard (integer), incremented each time the dashboard is updated", - "type": "number", - "minimum": 1 - }, - "links": {} - } - }, - "overwrite": { - "type": "boolean" - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/jenkins-config.json b/test/blackbox/docs/JsonSchemaDraft-4/jenkins-config.json deleted file mode 100644 index 9d0c410111..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/jenkins-config.json +++ /dev/null @@ -1,1623 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ProjectConfig", - "definitions": { - "AWSElasticBlockStoreVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "partition": { - "type": "integer" - }, - "readOnly": { - "type": "boolean" - }, - "volumeID": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "AddonConfig": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Agent": { - "properties": { - "container": { - "type": "string" - }, - "dir": { - "type": "string" - }, - "image": { - "type": "string" - }, - "label": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "AzureDiskVolumeSource": { - "properties": { - "cachingMode": { - "type": "string" - }, - "diskName": { - "type": "string" - }, - "diskURI": { - "type": "string" - }, - "fsType": { - "type": "string" - }, - "kind": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "AzureFileVolumeSource": { - "properties": { - "readOnly": { - "type": "boolean" - }, - "secretName": { - "type": "string" - }, - "shareName": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "CSIVolumeSource": { - "properties": { - "driver": { - "type": "string" - }, - "fsType": { - "type": "string" - }, - "nodePublishSecretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "readOnly": { - "type": "boolean" - }, - "volumeAttributes": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "additionalProperties": false, - "type": "object" - }, - "CephFSVolumeSource": { - "properties": { - "monitors": { - "items": { - "type": "string" - }, - "type": "array" - }, - "path": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "secretFile": { - "type": "string" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "user": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ChatConfig": { - "properties": { - "developerChannel": { - "type": "string" - }, - "kind": { - "type": "string" - }, - "url": { - "type": "string" - }, - "userChannel": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "CinderVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "volumeID": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ConfigMapKeySelector": { - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "optional": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ConfigMapProjection": { - "properties": { - "items": { - "items": { - "$ref": "#/definitions/KeyToPath" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "optional": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ConfigMapVolumeSource": { - "properties": { - "defaultMode": { - "type": "integer" - }, - "items": { - "items": { - "$ref": "#/definitions/KeyToPath" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "optional": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Container": { - "additionalProperties": true, - "type": "object" - }, - "DownwardAPIProjection": { - "properties": { - "items": { - "items": { - "$ref": "#/definitions/DownwardAPIVolumeFile" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "DownwardAPIVolumeFile": { - "properties": { - "fieldRef": { - "$ref": "#/definitions/ObjectFieldSelector" - }, - "mode": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "resourceFieldRef": { - "$ref": "#/definitions/ResourceFieldSelector" - } - }, - "additionalProperties": false, - "type": "object" - }, - "DownwardAPIVolumeSource": { - "properties": { - "defaultMode": { - "type": "integer" - }, - "items": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/DownwardAPIVolumeFile" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "EmptyDirVolumeSource": { - "properties": { - "medium": { - "type": "string" - }, - "sizeLimit": { - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false, - "type": "object" - }, - "EnvVar": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - }, - "valueFrom": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/EnvVarSource" - } - }, - "additionalProperties": false, - "type": "object" - }, - "EnvVarSource": { - "properties": { - "configMapKeyRef": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ConfigMapKeySelector" - }, - "fieldRef": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ObjectFieldSelector" - }, - "resourceFieldRef": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ResourceFieldSelector" - }, - "secretKeyRef": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/SecretKeySelector" - } - }, - "additionalProperties": false, - "type": "object" - }, - "FCVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "lun": { - "type": "integer" - }, - "readOnly": { - "type": "boolean" - }, - "targetWWNs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "wwids": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "FlexVolumeSource": { - "properties": { - "driver": { - "type": "string" - }, - "fsType": { - "type": "string" - }, - "options": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - } - }, - "additionalProperties": false, - "type": "object" - }, - "FlockerVolumeSource": { - "properties": { - "datasetName": { - "type": "string" - }, - "datasetUUID": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "GCEPersistentDiskVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "partition": { - "type": "integer" - }, - "pdName": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "GitRepoVolumeSource": { - "properties": { - "directory": { - "type": "string" - }, - "repository": { - "type": "string" - }, - "revision": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "GlusterfsVolumeSource": { - "properties": { - "endpoints": { - "type": "string" - }, - "path": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "HostPathVolumeSource": { - "properties": { - "path": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ISCSIVolumeSource": { - "properties": { - "chapAuthDiscovery": { - "type": "boolean" - }, - "chapAuthSession": { - "type": "boolean" - }, - "fsType": { - "type": "string" - }, - "initiatorName": { - "type": "string" - }, - "iqn": { - "type": "string" - }, - "iscsiInterface": { - "type": "string" - }, - "lun": { - "type": "integer" - }, - "portals": { - "items": { - "type": "string" - }, - "type": "array" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/LocalObjectReference" - }, - "targetPortal": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "IssueTrackerConfig": { - "properties": { - "kind": { - "type": "string" - }, - "project": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "KeyToPath": { - "properties": { - "key": { - "type": "string" - }, - "mode": { - "type": "integer" - }, - "path": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "LocalObjectReference": { - "properties": { - "name": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Loop": { - "properties": { - "steps": { - "items": { - "$ref": "#/definitions/Step" - }, - "type": "array" - }, - "values": { - "items": { - "type": "string" - }, - "type": "array" - }, - "variable": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "NFSVolumeSource": { - "properties": { - "path": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "server": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ObjectFieldSelector": { - "properties": { - "apiVersion": { - "type": "string" - }, - "fieldPath": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ParsedPipeline": { - "properties": { - "agent": { - "$ref": "#/definitions/Agent" - }, - "dir": { - "type": "string" - }, - "env": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "environment": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "options": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/RootOptions" - }, - "post": { - "items": { - "$ref": "#/definitions/Post" - }, - "type": "array" - }, - "stages": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Stage" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PersistentVolumeClaimVolumeSource": { - "properties": { - "claimName": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PhotonPersistentDiskVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "pdID": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PipelineConfig": { - "properties": { - "agent": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Agent" - }, - "containerOptions": { - "$ref": "#/definitions/Container" - }, - "env": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "environment": { - "type": "string" - }, - "extends": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PipelineExtends" - }, - "pipelines": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Pipelines" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PipelineExtends": { - "properties": { - "file": { - "type": "string" - }, - "import": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PipelineLifecycle": { - "properties": { - "preSteps": { - "items": { - "$ref": "#/definitions/Step" - }, - "type": "array" - }, - "replace": { - "type": "boolean" - }, - "steps": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Step" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PipelineLifecycles": { - "properties": { - "build": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "pipeline": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ParsedPipeline" - }, - "postBuild": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "preBuild": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "promote": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "setVersion": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "setup": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PipelineLifecycle" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PipelineOverride": { - "properties": { - "agent": { - "$ref": "#/definitions/Agent" - }, - "containerOptions": { - "$ref": "#/definitions/Container" - }, - "name": { - "type": "string" - }, - "pipeline": { - "type": "string" - }, - "sidecars": { - "items": { - "$ref": "#/definitions/Container" - }, - "type": "array" - }, - "stage": { - "type": "string" - }, - "step": { - "$ref": "#/definitions/Step" - }, - "steps": { - "items": { - "$ref": "#/definitions/Step" - }, - "type": "array" - }, - "type": { - "type": "string" - }, - "volumes": { - "items": { - "$ref": "#/definitions/Volume" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Pipelines": { - "properties": { - "default": { - "$ref": "#/definitions/ParsedPipeline" - }, - "feature": { - "$ref": "#/definitions/PipelineLifecycles" - }, - "overrides": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PipelineOverride" - }, - "type": "array" - }, - "post": { - "$ref": "#/definitions/PipelineLifecycle" - }, - "pullRequest": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PipelineLifecycles" - }, - "release": { - "$ref": "#/definitions/PipelineLifecycles" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PortworxVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "volumeID": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Post": { - "properties": { - "actions": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PostAction" - }, - "type": "array" - }, - "condition": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PostAction": { - "properties": { - "name": { - "type": "string" - }, - "options": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "additionalProperties": false, - "type": "object" - }, - "PreviewEnvironmentConfig": { - "properties": { - "disabled": { - "type": "boolean" - }, - "maximumInstances": { - "type": "integer" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ProjectConfig": { - "properties": { - "addons": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/AddonConfig" - }, - "type": "array" - }, - "buildPack": { - "type": "string" - }, - "buildPackGitRef": { - "type": "string" - }, - "buildPackGitURL": { - "type": "string" - }, - "chat": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ChatConfig" - }, - "dockerRegistryHost": { - "type": "string" - }, - "dockerRegistryOwner": { - "type": "string" - }, - "env": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "issueTracker": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/IssueTrackerConfig" - }, - "noReleasePrepare": { - "type": "boolean" - }, - "pipelineConfig": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PipelineConfig" - }, - "previewEnvironments": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PreviewEnvironmentConfig" - }, - "wiki": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/WikiConfig" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ProjectedVolumeSource": { - "properties": { - "defaultMode": { - "type": "integer" - }, - "sources": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/VolumeProjection" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Quantity": { - "additionalProperties": false, - "type": "object" - }, - "QuobyteVolumeSource": { - "properties": { - "group": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "registry": { - "type": "string" - }, - "tenant": { - "type": "string" - }, - "user": { - "type": "string" - }, - "volume": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "RBDVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "image": { - "type": "string" - }, - "keyring": { - "type": "string" - }, - "monitors": { - "items": { - "type": "string" - }, - "type": "array" - }, - "pool": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "user": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ResourceFieldSelector": { - "properties": { - "containerName": { - "type": "string" - }, - "divisor": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Quantity" - }, - "resource": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "RootOptions": { - "properties": { - "containerOptions": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Container" - }, - "distributeParallelAcrossNodes": { - "type": "boolean" - }, - "podLabels": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "retry": { - "type": "integer" - }, - "sidecars": { - "items": { - "$ref": "#/definitions/Container" - }, - "type": "array" - }, - "timeout": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Timeout" - }, - "tolerations": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Toleration" - }, - "type": "array" - }, - "volumes": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Volume" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ScaleIOVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "protectionDomain": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "sslEnabled": { - "type": "boolean" - }, - "storageMode": { - "type": "string" - }, - "storagePool": { - "type": "string" - }, - "system": { - "type": "string" - }, - "volumeName": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "SecretKeySelector": { - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "optional": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "SecretProjection": { - "properties": { - "items": { - "items": { - "$ref": "#/definitions/KeyToPath" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "optional": { - "type": "boolean" - } - }, - "additionalProperties": false, - "type": "object" - }, - "SecretVolumeSource": { - "properties": { - "defaultMode": { - "type": "integer" - }, - "items": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/KeyToPath" - }, - "type": "array" - }, - "optional": { - "type": "boolean" - }, - "secretName": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "ServiceAccountTokenProjection": { - "properties": { - "audience": { - "type": "string" - }, - "expirationSeconds": { - "type": "integer" - }, - "path": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Stage": { - "properties": { - "agent": { - "$ref": "#/definitions/Agent" - }, - "dir": { - "type": "string" - }, - "env": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "environment": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "options": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/StageOptions" - }, - "parallel": { - "items": { - "$ref": "#/definitions/Stage" - }, - "type": "array" - }, - "post": { - "items": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Post" - }, - "type": "array" - }, - "stages": { - "items": { - "$ref": "#/definitions/Stage" - }, - "type": "array" - }, - "steps": { - "items": { - "$ref": "#/definitions/Step" - }, - "type": "array" - } - }, - "additionalProperties": false, - "type": "object" - }, - "StageOptions": { - "properties": { - "containerOptions": { - "$ref": "#/definitions/Container" - }, - "distributeParallelAcrossNodes": { - "type": "boolean" - }, - "podLabels": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "retry": { - "type": "integer" - }, - "sidecars": { - "items": { - "$ref": "#/definitions/Container" - }, - "type": "array" - }, - "stash": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Stash" - }, - "timeout": { - "$ref": "#/definitions/Timeout" - }, - "tolerations": { - "items": { - "$ref": "#/definitions/Toleration" - }, - "type": "array" - }, - "unstash": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Unstash" - }, - "volumes": { - "items": { - "$ref": "#/definitions/Volume" - }, - "type": "array" - }, - "workspace": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Stash": { - "properties": { - "files": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Step": { - "properties": { - "agent": { - "$ref": "#/definitions/Agent" - }, - "args": { - "items": { - "type": "string" - }, - "type": "array" - }, - "command": { - "type": "string" - }, - "comment": { - "type": "string" - }, - "container": { - "type": "string" - }, - "dir": { - "type": "string" - }, - "env": { - "items": { - "$ref": "#/definitions/EnvVar" - }, - "type": "array" - }, - "groovy": { - "type": "string" - }, - "image": { - "type": "string" - }, - "loop": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/Loop" - }, - "name": { - "type": "string" - }, - "options": { - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "sh": { - "type": "string" - }, - "step": { - "type": "string" - }, - "steps": { - "items": { - "$ref": "#/definitions/Step" - }, - "type": "array" - }, - "when": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "StorageOSVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "readOnly": { - "type": "boolean" - }, - "secretRef": { - "$ref": "#/definitions/LocalObjectReference" - }, - "volumeName": { - "type": "string" - }, - "volumeNamespace": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Timeout": { - "properties": { - "time": { - "type": "integer" - }, - "unit": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Toleration": { - "properties": { - "effect": { - "type": "string" - }, - "key": { - "type": "string" - }, - "operator": { - "type": "string" - }, - "tolerationSeconds": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Unstash": { - "properties": { - "dir": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "Volume": { - "properties": { - "awsElasticBlockStore": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/AWSElasticBlockStoreVolumeSource" - }, - "azureDisk": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/AzureDiskVolumeSource" - }, - "azureFile": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/AzureFileVolumeSource" - }, - "cephfs": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/CephFSVolumeSource" - }, - "cinder": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/CinderVolumeSource" - }, - "configMap": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ConfigMapVolumeSource" - }, - "csi": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/CSIVolumeSource" - }, - "downwardAPI": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/DownwardAPIVolumeSource" - }, - "emptyDir": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/EmptyDirVolumeSource" - }, - "fc": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/FCVolumeSource" - }, - "flexVolume": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/FlexVolumeSource" - }, - "flocker": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/FlockerVolumeSource" - }, - "gcePersistentDisk": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/GCEPersistentDiskVolumeSource" - }, - "gitRepo": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/GitRepoVolumeSource" - }, - "glusterfs": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/GlusterfsVolumeSource" - }, - "hostPath": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/HostPathVolumeSource" - }, - "iscsi": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ISCSIVolumeSource" - }, - "name": { - "type": "string" - }, - "nfs": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/NFSVolumeSource" - }, - "persistentVolumeClaim": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PersistentVolumeClaimVolumeSource" - }, - "photonPersistentDisk": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PhotonPersistentDiskVolumeSource" - }, - "portworxVolume": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/PortworxVolumeSource" - }, - "projected": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ProjectedVolumeSource" - }, - "quobyte": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/QuobyteVolumeSource" - }, - "rbd": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/RBDVolumeSource" - }, - "scaleIO": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ScaleIOVolumeSource" - }, - "secret": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/SecretVolumeSource" - }, - "storageos": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/StorageOSVolumeSource" - }, - "vsphereVolume": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/VsphereVirtualDiskVolumeSource" - } - }, - "additionalProperties": false, - "type": "object" - }, - "VolumeProjection": { - "properties": { - "configMap": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ConfigMapProjection" - }, - "downwardAPI": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/DownwardAPIProjection" - }, - "secret": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/SecretProjection" - }, - "serviceAccountToken": { - "$schema": "http://json-schema.org/draft-04/schema#", - "$ref": "#/definitions/ServiceAccountTokenProjection" - } - }, - "additionalProperties": false, - "type": "object" - }, - "VsphereVirtualDiskVolumeSource": { - "properties": { - "fsType": { - "type": "string" - }, - "storagePolicyID": { - "type": "string" - }, - "storagePolicyName": { - "type": "string" - }, - "volumePath": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - }, - "WikiConfig": { - "properties": { - "kind": { - "type": "string" - }, - "space": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "additionalProperties": false, - "type": "object" - } - } - } - \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/nuget-project.json b/test/blackbox/docs/JsonSchemaDraft-4/nuget-project.json deleted file mode 100644 index 0288cf55d8..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/nuget-project.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "title": "JSON schema for NuGet project.json files", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "definitions": { - "configType": { - "type": "object", - "properties": { - "dependencies": { - "$ref": "#/definitions/dependencies" - }, - "imports": { - "type": "string" - } - } - }, - "dependencies": { - "description": "A list of dependencies.", - "type": "object", - "additionalProperties": { - "type": [ - "string", - "object" - ], - "properties": { - "version": { - "type": "string" - }, - "type": { - "type": "string", - "default": "default", - "enum": [ - "default", - "build" - ] - } - } - } - } - }, - "properties": { - "dependencies": { - "$ref": "#/definitions/dependencies" - }, - "frameworks": { - "type": "object", - "description": "The frameworks on which your project will run.", - "additionalProperties": { - "$ref": "#/definitions/configType" - } - }, - "runtimes": { - "type": "object", - "description": "The Operating System and Architectures on which your application will be running.", - "properties": { - "centos.7-x64": { - "type": "object" - }, - "debian.8-x64": { - "type": "object" - }, - "fedora.23-x64": { - "type": "object" - }, - "fedora.24-x64": { - "type": "object" - }, - "linuxmint.17-x64": { - "type": "object" - }, - "linuxmint.17.1-x64": { - "type": "object" - }, - "linuxmint.17.2-x64": { - "type": "object" - }, - "linuxmint.17.3-x64": { - "type": "object" - }, - "linuxmint.18-x64": { - "type": "object" - }, - "ol.7.0-x64": { - "type": "object" - }, - "ol.7.1-x64": { - "type": "object" - }, - "ol.7.2-x64": { - "type": "object" - }, - "opensuse.13.2-x64": { - "type": "object" - }, - "opensuse.42.1-x64": { - "type": "object" - }, - "osx.10.10-x64": { - "type": "object" - }, - "osx.10.11-x64": { - "type": "object" - }, - "osx.10.12-x64": { - "type": "object" - }, - "rhel.7.0-x64": { - "type": "object" - }, - "rhel.7.1-x64": { - "type": "object" - }, - "rhel.7.2-x64": { - "type": "object" - }, - "ubuntu.14.04-x64": { - "type": "object" - }, - "ubuntu.14.10-x64": { - "type": "object" - }, - "ubuntu.15.04-x64": { - "type": "object" - }, - "ubuntu.15.10-x64": { - "type": "object" - }, - "ubuntu.16.04-x64": { - "type": "object" - }, - "ubuntu.16.10-x64": { - "type": "object" - }, - "win": { - "type": "object" - }, - "win-x86": { - "type": "object" - }, - "win-x64": { - "type": "object" - }, - "win7": { - "type": "object" - }, - "win7-x86": { - "type": "object" - }, - "win7-x64": { - "type": "object" - }, - "win8": { - "type": "object" - }, - "win8-x86": { - "type": "object" - }, - "win8-x64": { - "type": "object" - }, - "win8-arm": { - "type": "object" - }, - "win81": { - "type": "object" - }, - "win81-x86": { - "type": "object" - }, - "win81-x64": { - "type": "object" - }, - "win81-arm": { - "type": "object" - }, - "win10-arm": { - "type": "object" - }, - "win10-arm-aot": { - "type": "object" - }, - "win10-x86": { - "type": "object" - }, - "win10-x86-aot": { - "type": "object" - }, - "win10-x64": { - "type": "object" - }, - "win10-x64-aot": { - "type": "object" - } - } - }, - "supports": { - "type": "object", - "description": "A list of supported target frameworks.", - "additionalProperties": { - "type": "object", - "description": "A supported target framework." - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/openapi-3.json b/test/blackbox/docs/JsonSchemaDraft-4/openapi-3.json deleted file mode 100644 index 05b5a2fabc..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/openapi-3.json +++ /dev/null @@ -1,1654 +0,0 @@ -{ - "id": "https://spec.openapis.org/oas/3.0/schema/2019-04-02", - "$schema": "http://json-schema.org/draft-04/schema#", - "description": "Validation schema for OpenAPI Specification 3.0.X.", - "type": "object", - "required": [ - "openapi", - "info", - "paths" - ], - "properties": { - "openapi": { - "type": "string", - "pattern": "^3\\.0\\.\\d(-.+)?$" - }, - "info": { - "$ref": "#/definitions/Info" - }, - "externalDocs": { - "$ref": "#/definitions/ExternalDocumentation" - }, - "servers": { - "type": "array", - "items": { - "$ref": "#/definitions/Server" - } - }, - "security": { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRequirement" - } - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/Tag" - }, - "uniqueItems": true - }, - "paths": { - "$ref": "#/definitions/Paths" - }, - "components": { - "$ref": "#/definitions/Components" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "definitions": { - "Reference": { - "type": "object", - "required": [ - "$ref" - ], - "patternProperties": { - "^\\$ref$": { - "type": "string", - "format": "uri-reference" - } - } - }, - "Info": { - "type": "object", - "required": [ - "title", - "version" - ], - "properties": { - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "termsOfService": { - "type": "string", - "format": "uri-reference" - }, - "contact": { - "$ref": "#/definitions/Contact" - }, - "license": { - "$ref": "#/definitions/License" - }, - "version": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Contact": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri-reference" - }, - "email": { - "type": "string", - "format": "email" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "License": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri-reference" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Server": { - "type": "object", - "required": [ - "url" - ], - "properties": { - "url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "variables": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ServerVariable" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "ServerVariable": { - "type": "object", - "required": [ - "default" - ], - "properties": { - "enum": { - "type": "array", - "items": { - "type": "string" - } - }, - "default": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Components": { - "type": "object", - "properties": { - "schemas": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - } - }, - "responses": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Response" - } - ] - } - } - }, - "parameters": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Parameter" - } - ] - } - } - }, - "examples": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Example" - } - ] - } - } - }, - "requestBodies": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/RequestBody" - } - ] - } - } - }, - "headers": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Header" - } - ] - } - } - }, - "securitySchemes": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/SecurityScheme" - } - ] - } - } - }, - "links": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Link" - } - ] - } - } - }, - "callbacks": { - "type": "object", - "patternProperties": { - "^[a-zA-Z0-9\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/Callback" - } - ] - } - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Schema": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "multipleOf": { - "type": "number", - "minimum": 0, - "exclusiveMinimum": true - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "boolean", - "default": false - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "boolean", - "default": false - }, - "maxLength": { - "type": "integer", - "minimum": 0 - }, - "minLength": { - "type": "integer", - "minimum": 0, - "default": 0 - }, - "pattern": { - "type": "string", - "format": "regex" - }, - "maxItems": { - "type": "integer", - "minimum": 0 - }, - "minItems": { - "type": "integer", - "minimum": 0, - "default": 0 - }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "maxProperties": { - "type": "integer", - "minimum": 0 - }, - "minProperties": { - "type": "integer", - "minimum": 0, - "default": 0 - }, - "required": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1, - "uniqueItems": true - }, - "enum": { - "type": "array", - "items": { - }, - "minItems": 1, - "uniqueItems": false - }, - "type": { - "type": "string", - "enum": [ - "array", - "boolean", - "integer", - "number", - "object", - "string" - ] - }, - "not": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "allOf": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "oneOf": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "anyOf": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "properties": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - }, - { - "type": "boolean" - } - ], - "default": true - }, - "description": { - "type": "string" - }, - "format": { - "type": "string" - }, - "default": { - }, - "nullable": { - "type": "boolean", - "default": false - }, - "discriminator": { - "$ref": "#/definitions/Discriminator" - }, - "readOnly": { - "type": "boolean", - "default": false - }, - "writeOnly": { - "type": "boolean", - "default": false - }, - "example": { - }, - "externalDocs": { - "$ref": "#/definitions/ExternalDocumentation" - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "xml": { - "$ref": "#/definitions/XML" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Discriminator": { - "type": "object", - "required": [ - "propertyName" - ], - "properties": { - "propertyName": { - "type": "string" - }, - "mapping": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "XML": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "namespace": { - "type": "string", - "format": "uri" - }, - "prefix": { - "type": "string" - }, - "attribute": { - "type": "boolean", - "default": false - }, - "wrapped": { - "type": "boolean", - "default": false - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Response": { - "type": "object", - "required": [ - "description" - ], - "properties": { - "description": { - "type": "string" - }, - "headers": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Header" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "content": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MediaType" - } - }, - "links": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Link" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "MediaType": { - "type": "object", - "properties": { - "schema": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "example": { - }, - "examples": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Example" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "encoding": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Encoding" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/definitions/ExampleXORExamples" - } - ] - }, - "Example": { - "type": "object", - "properties": { - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "value": { - }, - "externalValue": { - "type": "string", - "format": "uri-reference" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Header": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": false - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "allowEmptyValue": { - "type": "boolean", - "default": false - }, - "style": { - "type": "string", - "enum": [ - "simple" - ], - "default": "simple" - }, - "explode": { - "type": "boolean" - }, - "allowReserved": { - "type": "boolean", - "default": false - }, - "schema": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "content": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MediaType" - }, - "minProperties": 1, - "maxProperties": 1 - }, - "example": { - }, - "examples": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Example" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "allOf": [ - { - "$ref": "#/definitions/ExampleXORExamples" - }, - { - "$ref": "#/definitions/SchemaXORContent" - } - ] - }, - "Paths": { - "type": "object", - "patternProperties": { - "^\\/": { - "$ref": "#/definitions/PathItem" - }, - "^x-": { - } - }, - "additionalProperties": false - }, - "PathItem": { - "type": "object", - "properties": { - "$ref": { - "type": "string" - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "servers": { - "type": "array", - "items": { - "$ref": "#/definitions/Server" - } - }, - "parameters": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Parameter" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "uniqueItems": true - } - }, - "patternProperties": { - "^(get|put|post|delete|options|head|patch|trace)$": { - "$ref": "#/definitions/Operation" - }, - "^x-": { - } - }, - "additionalProperties": false - }, - "Operation": { - "type": "object", - "required": [ - "responses" - ], - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "externalDocs": { - "$ref": "#/definitions/ExternalDocumentation" - }, - "operationId": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Parameter" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "uniqueItems": true - }, - "requestBody": { - "oneOf": [ - { - "$ref": "#/definitions/RequestBody" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "responses": { - "$ref": "#/definitions/Responses" - }, - "callbacks": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Callback" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "security": { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRequirement" - } - }, - "servers": { - "type": "array", - "items": { - "$ref": "#/definitions/Server" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Responses": { - "type": "object", - "properties": { - "default": { - "oneOf": [ - { - "$ref": "#/definitions/Response" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - }, - "patternProperties": { - "^[1-5](?:\\d{2}|XX)$": { - "oneOf": [ - { - "$ref": "#/definitions/Response" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "^x-": { - } - }, - "minProperties": 1, - "additionalProperties": false - }, - "SecurityRequirement": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Tag": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "externalDocs": { - "$ref": "#/definitions/ExternalDocumentation" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "ExternalDocumentation": { - "type": "object", - "required": [ - "url" - ], - "properties": { - "description": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri-reference" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "ExampleXORExamples": { - "description": "Example and examples are mutually exclusive", - "not": { - "required": [ - "example", - "examples" - ] - } - }, - "SchemaXORContent": { - "description": "Schema and content are mutually exclusive, at least one is required", - "not": { - "required": [ - "schema", - "content" - ] - }, - "oneOf": [ - { - "required": [ - "schema" - ] - }, - { - "required": [ - "content" - ], - "description": "Some properties are not allowed if content is present", - "allOf": [ - { - "not": { - "required": [ - "style" - ] - } - }, - { - "not": { - "required": [ - "explode" - ] - } - }, - { - "not": { - "required": [ - "allowReserved" - ] - } - }, - { - "not": { - "required": [ - "example" - ] - } - }, - { - "not": { - "required": [ - "examples" - ] - } - } - ] - } - ] - }, - "Parameter": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "in": { - "type": "string" - }, - "description": { - "type": "string" - }, - "required": { - "type": "boolean", - "default": false - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "allowEmptyValue": { - "type": "boolean", - "default": false - }, - "style": { - "type": "string" - }, - "explode": { - "type": "boolean" - }, - "allowReserved": { - "type": "boolean", - "default": false - }, - "schema": { - "oneOf": [ - { - "$ref": "#/definitions/Schema" - }, - { - "$ref": "#/definitions/Reference" - } - ] - }, - "content": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MediaType" - }, - "minProperties": 1, - "maxProperties": 1 - }, - "example": { - }, - "examples": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/Example" - }, - { - "$ref": "#/definitions/Reference" - } - ] - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "required": [ - "name", - "in" - ], - "allOf": [ - { - "$ref": "#/definitions/ExampleXORExamples" - }, - { - "$ref": "#/definitions/SchemaXORContent" - }, - { - "$ref": "#/definitions/ParameterLocation" - } - ] - }, - "ParameterLocation": { - "description": "Parameter location", - "oneOf": [ - { - "description": "Parameter in path", - "required": [ - "required" - ], - "properties": { - "in": { - "enum": [ - "path" - ] - }, - "style": { - "enum": [ - "matrix", - "label", - "simple" - ], - "default": "simple" - }, - "required": { - "enum": [ - true - ] - } - } - }, - { - "description": "Parameter in query", - "properties": { - "in": { - "enum": [ - "query" - ] - }, - "style": { - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], - "default": "form" - } - } - }, - { - "description": "Parameter in header", - "properties": { - "in": { - "enum": [ - "header" - ] - }, - "style": { - "enum": [ - "simple" - ], - "default": "simple" - } - } - }, - { - "description": "Parameter in cookie", - "properties": { - "in": { - "enum": [ - "cookie" - ] - }, - "style": { - "enum": [ - "form" - ], - "default": "form" - } - } - } - ] - }, - "RequestBody": { - "type": "object", - "required": [ - "content" - ], - "properties": { - "description": { - "type": "string" - }, - "content": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MediaType" - } - }, - "required": { - "type": "boolean", - "default": false - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "SecurityScheme": { - "oneOf": [ - { - "$ref": "#/definitions/APIKeySecurityScheme" - }, - { - "$ref": "#/definitions/HTTPSecurityScheme" - }, - { - "$ref": "#/definitions/OAuth2SecurityScheme" - }, - { - "$ref": "#/definitions/OpenIdConnectSecurityScheme" - } - ] - }, - "APIKeySecurityScheme": { - "type": "object", - "required": [ - "type", - "name", - "in" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "apiKey" - ] - }, - "name": { - "type": "string" - }, - "in": { - "type": "string", - "enum": [ - "header", - "query", - "cookie" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "HTTPSecurityScheme": { - "type": "object", - "required": [ - "scheme", - "type" - ], - "properties": { - "scheme": { - "type": "string" - }, - "bearerFormat": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "http" - ] - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "oneOf": [ - { - "description": "Bearer", - "properties": { - "scheme": { - "enum": [ - "bearer" - ] - } - } - }, - { - "description": "Non Bearer", - "not": { - "required": [ - "bearerFormat" - ] - }, - "properties": { - "scheme": { - "not": { - "enum": [ - "bearer" - ] - } - } - } - } - ] - }, - "OAuth2SecurityScheme": { - "type": "object", - "required": [ - "type", - "flows" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "flows": { - "$ref": "#/definitions/OAuthFlows" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "OpenIdConnectSecurityScheme": { - "type": "object", - "required": [ - "type", - "openIdConnectUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "openIdConnect" - ] - }, - "openIdConnectUrl": { - "type": "string", - "format": "uri-reference" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "OAuthFlows": { - "type": "object", - "properties": { - "implicit": { - "$ref": "#/definitions/ImplicitOAuthFlow" - }, - "password": { - "$ref": "#/definitions/PasswordOAuthFlow" - }, - "clientCredentials": { - "$ref": "#/definitions/ClientCredentialsFlow" - }, - "authorizationCode": { - "$ref": "#/definitions/AuthorizationCodeOAuthFlow" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "ImplicitOAuthFlow": { - "type": "object", - "required": [ - "authorizationUrl", - "scopes" - ], - "properties": { - "authorizationUrl": { - "type": "string", - "format": "uri-reference" - }, - "refreshUrl": { - "type": "string", - "format": "uri-reference" - }, - "scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "PasswordOAuthFlow": { - "type": "object", - "required": [ - "tokenUrl" - ], - "properties": { - "tokenUrl": { - "type": "string", - "format": "uri-reference" - }, - "refreshUrl": { - "type": "string", - "format": "uri-reference" - }, - "scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "ClientCredentialsFlow": { - "type": "object", - "required": [ - "tokenUrl" - ], - "properties": { - "tokenUrl": { - "type": "string", - "format": "uri-reference" - }, - "refreshUrl": { - "type": "string", - "format": "uri-reference" - }, - "scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "AuthorizationCodeOAuthFlow": { - "type": "object", - "required": [ - "authorizationUrl", - "tokenUrl" - ], - "properties": { - "authorizationUrl": { - "type": "string", - "format": "uri-reference" - }, - "tokenUrl": { - "type": "string", - "format": "uri-reference" - }, - "refreshUrl": { - "type": "string", - "format": "uri-reference" - }, - "scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false - }, - "Link": { - "type": "object", - "properties": { - "operationId": { - "type": "string" - }, - "operationRef": { - "type": "string", - "format": "uri-reference" - }, - "parameters": { - "type": "object", - "additionalProperties": { - } - }, - "requestBody": { - }, - "description": { - "type": "string" - }, - "server": { - "$ref": "#/definitions/Server" - } - }, - "patternProperties": { - "^x-": { - } - }, - "additionalProperties": false, - "not": { - "description": "Operation Id and Operation Ref are mutually exclusive", - "required": [ - "operationId", - "operationRef" - ] - } - }, - "Callback": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PathItem" - }, - "patternProperties": { - "^x-": { - } - } - }, - "Encoding": { - "type": "object", - "properties": { - "contentType": { - "type": "string" - }, - "headers": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Header" - } - }, - "style": { - "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] - }, - "explode": { - "type": "boolean" - }, - "allowReserved": { - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - } - } \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/swagger-2_0.json b/test/blackbox/docs/JsonSchemaDraft-4/swagger-2_0.json deleted file mode 100644 index a92e18f2a5..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/swagger-2_0.json +++ /dev/null @@ -1,1607 +0,0 @@ -{ - "title": "A JSON Schema for Swagger 2.0 API.", - "id": "http://swagger.io/v2/schema.json#", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "required": [ - "swagger", - "info", - "paths" - ], - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "swagger": { - "type": "string", - "enum": [ - "2.0" - ], - "description": "The Swagger version of this document." - }, - "info": { - "$ref": "#/definitions/info" - }, - "host": { - "type": "string", - "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$", - "description": "The host (name or ip) of the API. Example: 'swagger.io'" - }, - "basePath": { - "type": "string", - "pattern": "^/", - "description": "The base path to the API. Example: '/api'." - }, - "schemes": { - "$ref": "#/definitions/schemesList" - }, - "consumes": { - "description": "A list of MIME types accepted by the API.", - "allOf": [ - { - "$ref": "#/definitions/mediaTypeList" - } - ] - }, - "produces": { - "description": "A list of MIME types the API can produce.", - "allOf": [ - { - "$ref": "#/definitions/mediaTypeList" - } - ] - }, - "paths": { - "$ref": "#/definitions/paths" - }, - "definitions": { - "$ref": "#/definitions/definitions" - }, - "parameters": { - "$ref": "#/definitions/parameterDefinitions" - }, - "responses": { - "$ref": "#/definitions/responseDefinitions" - }, - "security": { - "$ref": "#/definitions/security" - }, - "securityDefinitions": { - "$ref": "#/definitions/securityDefinitions" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - } - }, - "definitions": { - "info": { - "type": "object", - "description": "General information about the API.", - "required": [ - "version", - "title" - ], - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "title": { - "type": "string", - "description": "A unique and precise title of the API." - }, - "version": { - "type": "string", - "description": "A semantic version number of the API." - }, - "description": { - "type": "string", - "description": "A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed." - }, - "termsOfService": { - "type": "string", - "description": "The terms of service for the API." - }, - "contact": { - "$ref": "#/definitions/contact" - }, - "license": { - "$ref": "#/definitions/license" - } - } - }, - "contact": { - "type": "object", - "description": "Contact information for the owners of the API.", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The identifying name of the contact person/organization." - }, - "url": { - "type": "string", - "description": "The URL pointing to the contact information.", - "format": "uri" - }, - "email": { - "type": "string", - "description": "The email address of the contact person/organization.", - "format": "email" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "license": { - "type": "object", - "required": [ - "name" - ], - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the license type. It's encouraged to use an OSI compatible license." - }, - "url": { - "type": "string", - "description": "The URL pointing to the license.", - "format": "uri" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "paths": { - "type": "object", - "description": "Relative paths to the individual endpoints. They must be relative to the 'basePath'.", - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - }, - "^/": { - "$ref": "#/definitions/pathItem" - } - }, - "additionalProperties": false - }, - "definitions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/schema" - }, - "description": "One or more JSON objects describing the schemas being consumed and produced by the API." - }, - "parameterDefinitions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/parameter" - }, - "description": "One or more JSON representations for parameters" - }, - "responseDefinitions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/response" - }, - "description": "One or more JSON representations for responses" - }, - "externalDocs": { - "type": "object", - "additionalProperties": false, - "description": "information about external documentation", - "required": [ - "url" - ], - "properties": { - "description": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "examples": { - "type": "object", - "additionalProperties": true - }, - "mimeType": { - "type": "string", - "description": "The MIME type of the HTTP message." - }, - "operation": { - "type": "object", - "required": [ - "responses" - ], - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "summary": { - "type": "string", - "description": "A brief summary of the operation." - }, - "description": { - "type": "string", - "description": "A longer description of the operation, GitHub Flavored Markdown is allowed." - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "operationId": { - "type": "string", - "description": "A unique identifier of the operation." - }, - "produces": { - "description": "A list of MIME types the API can produce.", - "allOf": [ - { - "$ref": "#/definitions/mediaTypeList" - } - ] - }, - "consumes": { - "description": "A list of MIME types the API can consume.", - "allOf": [ - { - "$ref": "#/definitions/mediaTypeList" - } - ] - }, - "parameters": { - "$ref": "#/definitions/parametersList" - }, - "responses": { - "$ref": "#/definitions/responses" - }, - "schemes": { - "$ref": "#/definitions/schemesList" - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "security": { - "$ref": "#/definitions/security" - } - } - }, - "pathItem": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "$ref": { - "type": "string" - }, - "get": { - "$ref": "#/definitions/operation" - }, - "put": { - "$ref": "#/definitions/operation" - }, - "post": { - "$ref": "#/definitions/operation" - }, - "delete": { - "$ref": "#/definitions/operation" - }, - "options": { - "$ref": "#/definitions/operation" - }, - "head": { - "$ref": "#/definitions/operation" - }, - "patch": { - "$ref": "#/definitions/operation" - }, - "parameters": { - "$ref": "#/definitions/parametersList" - } - } - }, - "responses": { - "type": "object", - "description": "Response objects names can either be any valid HTTP status code or 'default'.", - "minProperties": 1, - "additionalProperties": false, - "patternProperties": { - "^([0-9]{3})$|^(default)$": { - "$ref": "#/definitions/responseValue" - }, - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "not": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - } - }, - "responseValue": { - "oneOf": [ - { - "$ref": "#/definitions/response" - }, - { - "$ref": "#/definitions/jsonReference" - } - ] - }, - "response": { - "type": "object", - "required": [ - "description" - ], - "properties": { - "description": { - "type": "string" - }, - "schema": { - "oneOf": [ - { - "$ref": "#/definitions/schema" - }, - { - "$ref": "#/definitions/fileSchema" - } - ] - }, - "headers": { - "$ref": "#/definitions/headers" - }, - "examples": { - "$ref": "#/definitions/examples" - } - }, - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "headers": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/header" - } - }, - "header": { - "type": "object", - "additionalProperties": false, - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormat" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "vendorExtension": { - "description": "Any property starting with x- is valid.", - "additionalProperties": true, - "additionalItems": true - }, - "bodyParameter": { - "type": "object", - "required": [ - "name", - "in", - "schema" - ], - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "name": { - "type": "string", - "description": "The name of the parameter." - }, - "in": { - "type": "string", - "description": "Determines the location of the parameter.", - "enum": [ - "body" - ] - }, - "required": { - "type": "boolean", - "description": "Determines whether or not this parameter is required or optional.", - "default": false - }, - "schema": { - "$ref": "#/definitions/schema" - } - }, - "additionalProperties": false - }, - "headerParameterSubSchema": { - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "required": { - "type": "boolean", - "description": "Determines whether or not this parameter is required or optional.", - "default": false - }, - "in": { - "type": "string", - "description": "Determines the location of the parameter.", - "enum": [ - "header" - ] - }, - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "name": { - "type": "string", - "description": "The name of the parameter." - }, - "type": { - "type": "string", - "enum": [ - "string", - "number", - "boolean", - "integer", - "array" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormat" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - } - } - }, - "queryParameterSubSchema": { - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "required": { - "type": "boolean", - "description": "Determines whether or not this parameter is required or optional.", - "default": false - }, - "in": { - "type": "string", - "description": "Determines the location of the parameter.", - "enum": [ - "query" - ] - }, - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "name": { - "type": "string", - "description": "The name of the parameter." - }, - "allowEmptyValue": { - "type": "boolean", - "default": false, - "description": "allows sending a parameter by name only or with an empty value." - }, - "type": { - "type": "string", - "enum": [ - "string", - "number", - "boolean", - "integer", - "array" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormatWithMulti" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - } - } - }, - "formDataParameterSubSchema": { - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "required": { - "type": "boolean", - "description": "Determines whether or not this parameter is required or optional.", - "default": false - }, - "in": { - "type": "string", - "description": "Determines the location of the parameter.", - "enum": [ - "formData" - ] - }, - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "name": { - "type": "string", - "description": "The name of the parameter." - }, - "allowEmptyValue": { - "type": "boolean", - "default": false, - "description": "allows sending a parameter by name only or with an empty value." - }, - "type": { - "type": "string", - "enum": [ - "string", - "number", - "boolean", - "integer", - "array", - "file" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormatWithMulti" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - } - } - }, - "pathParameterSubSchema": { - "additionalProperties": false, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "required": [ - "required" - ], - "properties": { - "required": { - "type": "boolean", - "enum": [ - true - ], - "description": "Determines whether or not this parameter is required or optional." - }, - "in": { - "type": "string", - "description": "Determines the location of the parameter.", - "enum": [ - "path" - ] - }, - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "name": { - "type": "string", - "description": "The name of the parameter." - }, - "type": { - "type": "string", - "enum": [ - "string", - "number", - "boolean", - "integer", - "array" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormat" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - } - } - }, - "nonBodyParameter": { - "type": "object", - "required": [ - "name", - "in", - "type" - ], - "oneOf": [ - { - "$ref": "#/definitions/headerParameterSubSchema" - }, - { - "$ref": "#/definitions/formDataParameterSubSchema" - }, - { - "$ref": "#/definitions/queryParameterSubSchema" - }, - { - "$ref": "#/definitions/pathParameterSubSchema" - } - ] - }, - "parameter": { - "oneOf": [ - { - "$ref": "#/definitions/bodyParameter" - }, - { - "$ref": "#/definitions/nonBodyParameter" - } - ] - }, - "schema": { - "type": "object", - "description": "A deterministic version of a JSON Schema object.", - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "properties": { - "$ref": { - "type": "string" - }, - "format": { - "type": "string" - }, - "title": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/title" - }, - "description": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/description" - }, - "default": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/default" - }, - "multipleOf": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/multipleOf" - }, - "maximum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/maximum" - }, - "exclusiveMaximum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum" - }, - "minimum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/minimum" - }, - "exclusiveMinimum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum" - }, - "maxLength": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger" - }, - "minLength": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0" - }, - "pattern": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/pattern" - }, - "maxItems": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger" - }, - "minItems": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0" - }, - "uniqueItems": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/uniqueItems" - }, - "maxProperties": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger" - }, - "minProperties": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0" - }, - "required": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray" - }, - "enum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/enum" - }, - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/definitions/schema" - }, - { - "type": "boolean" - } - ], - "default": {} - }, - "type": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/type" - }, - "items": { - "anyOf": [ - { - "$ref": "#/definitions/schema" - }, - { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - } - ], - "default": {} - }, - "allOf": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/schema" - }, - "default": {} - }, - "discriminator": { - "type": "string" - }, - "readOnly": { - "type": "boolean", - "default": false - }, - "xml": { - "$ref": "#/definitions/xml" - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "example": {} - }, - "additionalProperties": false - }, - "fileSchema": { - "type": "object", - "description": "A deterministic version of a JSON Schema object.", - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - }, - "required": [ - "type" - ], - "properties": { - "format": { - "type": "string" - }, - "title": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/title" - }, - "description": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/description" - }, - "default": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/default" - }, - "required": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray" - }, - "type": { - "type": "string", - "enum": [ - "file" - ] - }, - "readOnly": { - "type": "boolean", - "default": false - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "example": {} - }, - "additionalProperties": false - }, - "primitivesItems": { - "type": "object", - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array" - ] - }, - "format": { - "type": "string" - }, - "items": { - "$ref": "#/definitions/primitivesItems" - }, - "collectionFormat": { - "$ref": "#/definitions/collectionFormat" - }, - "default": { - "$ref": "#/definitions/default" - }, - "maximum": { - "$ref": "#/definitions/maximum" - }, - "exclusiveMaximum": { - "$ref": "#/definitions/exclusiveMaximum" - }, - "minimum": { - "$ref": "#/definitions/minimum" - }, - "exclusiveMinimum": { - "$ref": "#/definitions/exclusiveMinimum" - }, - "maxLength": { - "$ref": "#/definitions/maxLength" - }, - "minLength": { - "$ref": "#/definitions/minLength" - }, - "pattern": { - "$ref": "#/definitions/pattern" - }, - "maxItems": { - "$ref": "#/definitions/maxItems" - }, - "minItems": { - "$ref": "#/definitions/minItems" - }, - "uniqueItems": { - "$ref": "#/definitions/uniqueItems" - }, - "enum": { - "$ref": "#/definitions/enum" - }, - "multipleOf": { - "$ref": "#/definitions/multipleOf" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "security": { - "type": "array", - "items": { - "$ref": "#/definitions/securityRequirement" - }, - "uniqueItems": true - }, - "securityRequirement": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - } - }, - "xml": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "namespace": { - "type": "string" - }, - "prefix": { - "type": "string" - }, - "attribute": { - "type": "boolean", - "default": false - }, - "wrapped": { - "type": "boolean", - "default": false - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "tag": { - "type": "object", - "additionalProperties": false, - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "securityDefinitions": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "$ref": "#/definitions/basicAuthenticationSecurity" - }, - { - "$ref": "#/definitions/apiKeySecurity" - }, - { - "$ref": "#/definitions/oauth2ImplicitSecurity" - }, - { - "$ref": "#/definitions/oauth2PasswordSecurity" - }, - { - "$ref": "#/definitions/oauth2ApplicationSecurity" - }, - { - "$ref": "#/definitions/oauth2AccessCodeSecurity" - } - ] - } - }, - "basicAuthenticationSecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "basic" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "apiKeySecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type", - "name", - "in" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "apiKey" - ] - }, - "name": { - "type": "string" - }, - "in": { - "type": "string", - "enum": [ - "header", - "query" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "oauth2ImplicitSecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type", - "flow", - "authorizationUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "flow": { - "type": "string", - "enum": [ - "implicit" - ] - }, - "scopes": { - "$ref": "#/definitions/oauth2Scopes" - }, - "authorizationUrl": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "oauth2PasswordSecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type", - "flow", - "tokenUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "flow": { - "type": "string", - "enum": [ - "password" - ] - }, - "scopes": { - "$ref": "#/definitions/oauth2Scopes" - }, - "tokenUrl": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "oauth2ApplicationSecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type", - "flow", - "tokenUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "flow": { - "type": "string", - "enum": [ - "application" - ] - }, - "scopes": { - "$ref": "#/definitions/oauth2Scopes" - }, - "tokenUrl": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "oauth2AccessCodeSecurity": { - "type": "object", - "additionalProperties": false, - "required": [ - "type", - "flow", - "authorizationUrl", - "tokenUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "flow": { - "type": "string", - "enum": [ - "accessCode" - ] - }, - "scopes": { - "$ref": "#/definitions/oauth2Scopes" - }, - "authorizationUrl": { - "type": "string", - "format": "uri" - }, - "tokenUrl": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-": { - "$ref": "#/definitions/vendorExtension" - } - } - }, - "oauth2Scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "mediaTypeList": { - "type": "array", - "items": { - "$ref": "#/definitions/mimeType" - }, - "uniqueItems": true - }, - "parametersList": { - "type": "array", - "description": "The parameters needed to send a valid API call.", - "additionalItems": false, - "items": { - "oneOf": [ - { - "$ref": "#/definitions/parameter" - }, - { - "$ref": "#/definitions/jsonReference" - } - ] - }, - "uniqueItems": true - }, - "schemesList": { - "type": "array", - "description": "The transfer protocol of the API.", - "items": { - "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] - }, - "uniqueItems": true - }, - "collectionFormat": { - "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], - "default": "csv" - }, - "collectionFormatWithMulti": { - "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], - "default": "csv" - }, - "title": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/title" - }, - "description": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/description" - }, - "default": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/default" - }, - "multipleOf": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/multipleOf" - }, - "maximum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/maximum" - }, - "exclusiveMaximum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMaximum" - }, - "minimum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/minimum" - }, - "exclusiveMinimum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/exclusiveMinimum" - }, - "maxLength": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger" - }, - "minLength": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0" - }, - "pattern": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/pattern" - }, - "maxItems": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveInteger" - }, - "minItems": { - "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0" - }, - "uniqueItems": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/uniqueItems" - }, - "enum": { - "$ref": "http://json-schema.org/draft-04/schema#/properties/enum" - }, - "jsonReference": { - "type": "object", - "required": [ - "$ref" - ], - "additionalProperties": false, - "properties": { - "$ref": { - "type": "string" - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-4/traefik-v2.json b/test/blackbox/docs/JsonSchemaDraft-4/traefik-v2.json deleted file mode 100644 index 2af047e3e3..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-4/traefik-v2.json +++ /dev/null @@ -1,1184 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "description": "Traefik v2 YAML Config schema", - "type": "object", - "definitions": { - "entrypoint": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "transport": { - "type": "object", - "properties": { - "lifeCycle": { - "type": "object", - "properties": { - "requestAcceptGraceTimeout": { - "type": "integer" - }, - "graceTimeOut": { - "type": "integer" - } - } - }, - "respondingTimeouts": { - "type": "object", - "properties": { - "readTimeout": { - "type": "integer" - }, - "writeTimeout": { - "type": "integer" - }, - "idleTimeout": { - "type": "integer" - } - } - } - } - }, - "proxyProtocol": { - "type": "object", - "properties": { - "insecure": { - "type": "boolean" - }, - "trustedIPs": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "forwardedHeaders": { - "type": "object", - "properties": { - "insecure": { - "type": "boolean" - }, - "trustedIPs": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "http": { - "type": "object", - "properties": { - "redirections": { - "type": "object", - "properties": { - "entryPoint": { - "type": "object", - "properties": { - "to": { - "type": "string" - }, - "scheme": { - "type": "string" - }, - "permanent": { - "type": "boolean" - }, - "priority": { - "type": "integer" - } - } - } - } - }, - "middlewares": { - "type": "array", - "items": { - "type": "string" - } - }, - "tls": { - "type": "object", - "properties": { - "options": { - "type": "string" - }, - "certResolver": { - "type": "string" - }, - "domains": { - "type": "array", - "items": { - "type": "object", - "properties": { - "main": { - "type": "string" - }, - "sans": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - }, - "provider-marathon": { - "type": "object", - "properties": { - "constraints": { - "type": "string" - }, - "trace": { - "type": "boolean" - }, - "watch": { - "type": "boolean" - }, - "endpoint": { - "type": "string" - }, - "defaultRule": { - "type": "string" - }, - "exposedByDefault": { - "type": "boolean" - }, - "dcosToken": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - }, - "dialerTimeout": { - "type": "integer" - }, - "responseHeaderTimeout": { - "type": "integer" - }, - "tlsHandshakeTimeout": { - "type": "integer" - }, - "keepAlive": { - "type": "integer" - }, - "forceTaskHostname": { - "type": "boolean" - }, - "basic": { - "type": "object", - "properties": { - "httpBasicAuthUser": { - "type": "string" - }, - "httpBasicPassword": { - "type": "string" - } - } - }, - "respectReadinessChecks": { - "type": "boolean" - } - } - }, - "provider-file": { - "type": "object", - "properties": { - "directory": { - "type": "string" - }, - "watch": { - "type": "boolean" - }, - "filename": { - "type": "string" - }, - "debugLogGeneratedTemplate": { - "type": "boolean" - } - } - }, - "provider-docker": { - "type": "object", - "properties": { - "constraints": { - "type": "string" - }, - "watch": { - "type": "boolean" - }, - "endpoint": { - "type": "string" - }, - "defaultRule": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - }, - "exposedByDefault": { - "type": "boolean" - }, - "useBindPortIP": { - "type": "boolean" - }, - "swarmMode": { - "type": "boolean" - }, - "network": { - "type": "string" - }, - "swarmModeRefreshSeconds": { - "type": "integer" - } - } - }, - "provider-kubernetes-crd": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - }, - "token": { - "type": "string" - }, - "certAuthFilePath": { - "type": "string" - }, - "disablePassHostHeaders": { - "type": "boolean" - }, - "namespaces": { - "type": "array", - "items": { - "type": "string" - } - }, - "labelSelector": { - "type": "string" - }, - "ingressClass": { - "type": "string" - }, - "throttleDuration": { - "type": "string" - } - } - }, - "provider-kubernetes-ingress": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - }, - "token": { - "type": "string" - }, - "certAuthFilePath": { - "type": "string" - }, - "disablePassHostHeaders": { - "type": "boolean" - }, - "namespaces": { - "type": "array", - "items": { - "type": "string" - } - }, - "labelSelector": { - "type": "string" - }, - "ingressClass": { - "type": "string" - }, - "throttleDuration": { - "type": "string" - }, - "ingressEndpoint": { - "type": "object", - "properties": { - "ip": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "publishedService": { - "type": "string" - } - } - } - } - }, - "provider-rest": { - "type": "object", - "properties": { - "insecure": { - "type": "boolean" - } - } - }, - "provider-rancher": { - "type": "object", - "properties": { - "constraints": { - "type": "string" - }, - "watch": { - "type": "boolean" - }, - "defaultRule": { - "type": "string" - }, - "exposedByDefault": { - "type": "boolean" - }, - "enableServiceHealthFilter": { - "type": "boolean" - }, - "refreshSeconds": { - "type": "integer" - }, - "intervalPoll": { - "type": "boolean" - }, - "prefix": { - "type": "string" - } - } - }, - "provider-consul-catalog": { - "type": "object", - "properties": { - "constraints": { - "type": "string" - }, - "prefix": { - "type": "string" - }, - "refreshInterval": { - "type": "string" - }, - "requireConsistent": { - "type": "boolean" - }, - "stale": { - "type": "boolean" - }, - "cache": { - "type": "boolean" - }, - "exposedByDefault": { - "type": "boolean" - }, - "defaultRule": { - "type": "string" - }, - "endpoint": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "scheme": { - "type": "string" - }, - "datacenter": { - "type": "string" - }, - "token": { - "type": "string" - }, - "endpointWaitTime": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - }, - "httpAuth": { - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - } - } - } - } - }, - "provider-consul": { - "type": "object", - "properties": { - "rootKey": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - } - } - }, - "provider-etcd": { - "type": "object", - "properties": { - "rootKey": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - } - } - }, - "provider-zookeeper": { - "type": "object", - "properties": { - "rootKey": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - } - } - }, - "provider-redis": { - "type": "object", - "properties": { - "rootKey": { - "type": "string" - }, - "endpoints": { - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "tls": { - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "caOptional": { - "type": "boolean" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - }, - "insecureSkipVerify": { - "type": "boolean" - } - } - } - } - }, - "metric-statsd": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "pushInterval": { - "type": "integer" - }, - "addEntryPointsLabels": { - "type": "boolean" - }, - "addServicesLabels": { - "type": "boolean" - }, - "prefix": { - "type": "string" - } - } - }, - "metric-prometheus": { - "type": "object", - "properties": { - "buckets": { - "type": "array", - "items": { - "type": "integer" - } - }, - "addEntryPointsLabels": { - "type": "boolean" - }, - "addServicesLabels": { - "type": "boolean" - }, - "entryPoint": { - "type": "string" - }, - "manualRouting": { - "type": "boolean" - } - } - }, - "metric-datadog": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "pushInterval": { - "type": "integer" - }, - "addEntryPointsLabels": { - "type": "boolean" - }, - "addServicesLabels": { - "type": "boolean" - } - } - }, - "metric-influxdb": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "protocol": { - "type": "string" - }, - "pushInterval": { - "type": "integer" - }, - "database": { - "type": "string" - }, - "retentionPolicy": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "addEntryPointsLabels": { - "type": "boolean" - }, - "addServicesLabels": { - "type": "boolean" - } - } - }, - "tracing-jaeger": { - "type": "object", - "properties": { - "samplingServerURL": { - "type": "string" - }, - "samplingType": { - "type": "string" - }, - "samplingParam": { - "type": "integer" - }, - "localAgentHostPort": { - "type": "string" - }, - "gen128Bit": { - "type": "boolean" - }, - "propagation": { - "type": "string" - }, - "traceContextHeaderName": { - "type": "string" - }, - "collector": { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - }, - "user": { - "type": "string" - }, - "password": { - "type": "string" - } - } - } - } - }, - "tracing-zipkin": { - "type": "object", - "properties": { - "httpEndpoint": { - "type": "string" - }, - "sameSpan": { - "type": "boolean" - }, - "id128Bit": { - "type": "boolean" - }, - "sampleRate": { - "type": "integer" - } - } - }, - "tracing-datadog": { - "type": "object", - "properties": { - "localAgentHostPort": { - "type": "string" - }, - "globalTag": { - "type": "string" - }, - "debug": { - "type": "boolean" - }, - "prioritySampling": { - "type": "boolean" - }, - "traceIDHeaderName": { - "type": "string" - }, - "parentIDHeaderName": { - "type": "string" - }, - "samplingPriorityHeaderName": { - "type": "string" - }, - "bagagePrefixHeaderName": { - "type": "string" - } - } - }, - "tracing-instana": { - "type": "object", - "properties": { - "localAgentHost": { - "type": "string" - }, - "localAgentPort": { - "type": "integer" - }, - "logLevel": { - "type": "string" - } - } - }, - "tracing-haystack": { - "type": "object", - "properties": { - "localAgentHost": { - "type": "string" - }, - "localAgentPort": { - "type": "integer" - }, - "globalTag": { - "type": "string" - }, - "traceIDHeaderName": { - "type": "string" - }, - "parentIDHeaderName": { - "type": "string" - }, - "spanIDHeaderName": { - "type": "string" - }, - "baggagePrefixHeaderName": { - "type": "string" - } - } - }, - "tracing-elastic": { - "type": "object", - "properties": { - "serverURL": { - "type": "string" - }, - "secretToken": { - "type": "string" - }, - "serviceEnvironment": { - "type": "string" - } - } - } - }, - "properties": { - "global": { - "type": "object", - "properties": { - "checkNewVersion": { - "type": "boolean" - }, - "sendAnonymousUsage": { - "type": "boolean" - } - } - }, - "serversTransport": { - "type": "object", - "properties": { - "insecureSkipVerify": { - "type": "boolean" - }, - "rootCAs": { - "type": "array", - "items": { - "type": "string" - } - }, - "maxIdleConnsPerHost": { - "type": "integer" - }, - "forwardingTimeouts": { - "type": "object", - "properties": { - "dialTimeout": { - "type": "integer" - }, - "responseHeaderTimeout": { - "type": "integer" - }, - "idleConnTimeout": { - "type": "integer" - } - } - } - } - }, - "entryPoints": { - "type": "object", - "patternProperties": { - "[a-zA-Z0-9_-]": { - "$ref": "#/definitions/entrypoint" - } - } - }, - "providers": { - "type": "object", - "properties": { - "providersThrottleDuration": { - "type": "integer" - }, - "docker": { - "$ref": "#/definitions/provider-docker" - }, - "file": { - "$ref": "#/definitions/provider-file" - }, - "kubernetesIngress": { - "$ref": "#/definitions/provider-kubernetes-ingress" - }, - "kubernetesCRD": { - "$ref": "#/definitions/provider-kubernetes-crd" - }, - "rest": { - "$ref": "#/definitions/provider-rest" - }, - "rancher": { - "$ref": "#/definitions/provider-rancher" - }, - "consulCatalog": { - "$ref": "#/definitions/provider-consul-catalog" - }, - "consul": { - "$ref": "#/definitions/provider-consul" - }, - "etcd": { - "$ref": "#/definitions/provider-etcd" - }, - "zooKeeper": { - "$ref": "#/definitions/provider-zookeeper" - }, - "redis": { - "$ref": "#/definitions/provider-redis" - } - } - }, - "api": { - "type": "object", - "properties": { - "insecure": { - "type": "boolean" - }, - "dashboard": { - "type": "boolean" - }, - "debug": { - "type": "boolean" - } - } - }, - "metrics": { - "type": "object", - "properties": { - "prometheus": { - "$ref": "#/definitions/metric-prometheus" - }, - "datadog": { - "$ref": "#/definitions/metric-datadog" - }, - "statsD": { - "$ref": "#/definitions/metric-statsd" - }, - "influxDB": { - "$ref": "#/definitions/metric-influxdb" - } - } - }, - "ping": { - "type": "object", - "properties": { - "entryPoint": { - "type": "string" - }, - "manualRouting": { - "type": "boolean" - } - } - }, - "log": { - "type": "object", - "properties": { - "level": { - "type": "string" - }, - "filePath": { - "type": "string" - }, - "format": { - "type": "string" - } - } - }, - "accessLog": { - "type": "object", - "properties": { - "filePath": { - "type": "string" - }, - "format": { - "type": "string" - }, - "filters": { - "type": "object", - "properties": { - "statusCodes": { - "type": "array", - "items": { - "type": "string" - } - }, - "retryAttempts": { - "type": "boolean" - }, - "minDuration": { - "type": "integer" - } - } - }, - "fields": { - "type": "object", - "properties": { - "defaultMode": { - "type": "string" - }, - "names": { - "type": "object", - "properties": { - "name0": { - "type": "string" - }, - "name1": { - "type": "string" - } - } - }, - "headers": { - "type": "object", - "properties": { - "defaultMode": { - "type": "string" - }, - "names": { - "type": "object", - "properties": { - "name0": { - "type": "string" - }, - "name1": { - "type": "string" - } - } - } - } - } - } - }, - "bufferingSize": { - "type": "integer" - } - } - }, - "tracing": { - "type": "object", - "properties": { - "serviceName": { - "type": "string" - }, - "spanNameLimit": { - "type": "integer" - }, - "jaeger": { - "$ref": "#/definitions/tracing-jaeger" - }, - "zipkin": { - "$ref": "#/definitions/tracing-zipkin" - }, - "datadog": { - "$ref": "#/definitions/tracing-datadog" - }, - "instana": { - "$ref": "#/definitions/tracing-instana" - }, - "haystack": { - "$ref": "#/definitions/tracing-haystack" - }, - "elastic": { - "$ref": "#/definitions/tracing-elastic" - } - } - }, - "hostResolver": { - "type": "object", - "properties": { - "cnameFlattening": { - "type": "boolean" - }, - "resolvConfig": { - "type": "string" - }, - "resolvDepth": { - "type": "integer" - } - } - }, - "certificatesResolvers": { - "type": "object", - "patternProperties": { - "[a-zA-Z]": { - "type": "object", - "properties": { - "acme": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "caServer": { - "type": "string" - }, - "storage": { - "type": "string" - }, - "keyType": { - "type": "string" - }, - "dnsChallenge": { - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "delayBeforeCheck": { - "type": "integer" - }, - "resolvers": { - "type": "array", - "items": { - "type": "string" - } - }, - "disablePropagationCheck": { - "type": "boolean" - } - } - }, - "httpChallenge": { - "type": "object", - "properties": { - "entryPoint": { - "type": "string" - } - } - }, - "tlsChallenge": { - "type": "object" - } - } - } - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-6/draft-6-core.json b/test/blackbox/docs/JsonSchemaDraft-6/draft-6-core.json deleted file mode 100644 index bd3e763bc2..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-6/draft-6-core.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-06/schema#", - "$id": "http://json-schema.org/draft-06/schema#", - "title": "Core schema meta-schema", - "definitions": { - "schemaArray": { - "type": "array", - "minItems": 1, - "items": { "$ref": "#" } - }, - "nonNegativeInteger": { - "type": "integer", - "minimum": 0 - }, - "nonNegativeIntegerDefault0": { - "allOf": [ - { "$ref": "#/definitions/nonNegativeInteger" }, - { "default": 0 } - ] - }, - "simpleTypes": { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - "stringArray": { - "type": "array", - "items": { "type": "string" }, - "uniqueItems": true, - "default": [] - } - }, - "type": ["object", "boolean"], - "properties": { - "$id": { - "type": "string", - "format": "uri-reference" - }, - "$schema": { - "type": "string", - "format": "uri" - }, - "$ref": { - "type": "string", - "format": "uri-reference" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default": {}, - "examples": { - "type": "array", - "items": {} - }, - "multipleOf": { - "type": "number", - "exclusiveMinimum": 0 - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "number" - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "number" - }, - "maxLength": { "$ref": "#/definitions/nonNegativeInteger" }, - "minLength": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "pattern": { - "type": "string", - "format": "regex" - }, - "additionalItems": { "$ref": "#" }, - "items": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/schemaArray" } - ], - "default": {} - }, - "maxItems": { "$ref": "#/definitions/nonNegativeInteger" }, - "minItems": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "contains": { "$ref": "#" }, - "maxProperties": { "$ref": "#/definitions/nonNegativeInteger" }, - "minProperties": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "required": { "$ref": "#/definitions/stringArray" }, - "additionalProperties": { "$ref": "#" }, - "definitions": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "properties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "propertyNames": { "format": "regex" }, - "default": {} - }, - "dependencies": { - "type": "object", - "additionalProperties": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/stringArray" } - ] - } - }, - "propertyNames": { "$ref": "#" }, - "const": {}, - "enum": { - "type": "array", - "minItems": 1, - "uniqueItems": true - }, - "type": { - "anyOf": [ - { "$ref": "#/definitions/simpleTypes" }, - { - "type": "array", - "items": { "$ref": "#/definitions/simpleTypes" }, - "minItems": 1, - "uniqueItems": true - } - ] - }, - "format": { "type": "string" }, - "allOf": { "$ref": "#/definitions/schemaArray" }, - "anyOf": { "$ref": "#/definitions/schemaArray" }, - "oneOf": { "$ref": "#/definitions/schemaArray" }, - "not": { "$ref": "#" } - }, - "default": {} -} diff --git a/test/blackbox/docs/JsonSchemaDraft-6/fhir-full.json b/test/blackbox/docs/JsonSchemaDraft-6/fhir-full.json deleted file mode 100644 index 910b5c540f..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-6/fhir-full.json +++ /dev/null @@ -1,60923 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-06/schema#", - "id": "http://hl7.org/fhir/json-schema/4.0", - "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", - "discriminator": { - "propertyName": "resourceType", - "mapping": { - "Account": "#/definitions/Account", - "ActivityDefinition": "#/definitions/ActivityDefinition", - "AdverseEvent": "#/definitions/AdverseEvent", - "AllergyIntolerance": "#/definitions/AllergyIntolerance", - "Appointment": "#/definitions/Appointment", - "AppointmentResponse": "#/definitions/AppointmentResponse", - "AuditEvent": "#/definitions/AuditEvent", - "Basic": "#/definitions/Basic", - "Binary": "#/definitions/Binary", - "BiologicallyDerivedProduct": "#/definitions/BiologicallyDerivedProduct", - "BodyStructure": "#/definitions/BodyStructure", - "Bundle": "#/definitions/Bundle", - "CapabilityStatement": "#/definitions/CapabilityStatement", - "CarePlan": "#/definitions/CarePlan", - "CareTeam": "#/definitions/CareTeam", - "CatalogEntry": "#/definitions/CatalogEntry", - "ChargeItem": "#/definitions/ChargeItem", - "ChargeItemDefinition": "#/definitions/ChargeItemDefinition", - "Claim": "#/definitions/Claim", - "ClaimResponse": "#/definitions/ClaimResponse", - "ClinicalImpression": "#/definitions/ClinicalImpression", - "CodeSystem": "#/definitions/CodeSystem", - "Communication": "#/definitions/Communication", - "CommunicationRequest": "#/definitions/CommunicationRequest", - "CompartmentDefinition": "#/definitions/CompartmentDefinition", - "Composition": "#/definitions/Composition", - "ConceptMap": "#/definitions/ConceptMap", - "Condition": "#/definitions/Condition", - "Consent": "#/definitions/Consent", - "Contract": "#/definitions/Contract", - "Coverage": "#/definitions/Coverage", - "CoverageEligibilityRequest": "#/definitions/CoverageEligibilityRequest", - "CoverageEligibilityResponse": "#/definitions/CoverageEligibilityResponse", - "DetectedIssue": "#/definitions/DetectedIssue", - "Device": "#/definitions/Device", - "DeviceDefinition": "#/definitions/DeviceDefinition", - "DeviceMetric": "#/definitions/DeviceMetric", - "DeviceRequest": "#/definitions/DeviceRequest", - "DeviceUseStatement": "#/definitions/DeviceUseStatement", - "DiagnosticReport": "#/definitions/DiagnosticReport", - "DocumentManifest": "#/definitions/DocumentManifest", - "DocumentReference": "#/definitions/DocumentReference", - "EffectEvidenceSynthesis": "#/definitions/EffectEvidenceSynthesis", - "Encounter": "#/definitions/Encounter", - "Endpoint": "#/definitions/Endpoint", - "EnrollmentRequest": "#/definitions/EnrollmentRequest", - "EnrollmentResponse": "#/definitions/EnrollmentResponse", - "EpisodeOfCare": "#/definitions/EpisodeOfCare", - "EventDefinition": "#/definitions/EventDefinition", - "Evidence": "#/definitions/Evidence", - "EvidenceVariable": "#/definitions/EvidenceVariable", - "ExampleScenario": "#/definitions/ExampleScenario", - "ExplanationOfBenefit": "#/definitions/ExplanationOfBenefit", - "FamilyMemberHistory": "#/definitions/FamilyMemberHistory", - "Flag": "#/definitions/Flag", - "Goal": "#/definitions/Goal", - "GraphDefinition": "#/definitions/GraphDefinition", - "Group": "#/definitions/Group", - "GuidanceResponse": "#/definitions/GuidanceResponse", - "HealthcareService": "#/definitions/HealthcareService", - "ImagingStudy": "#/definitions/ImagingStudy", - "Immunization": "#/definitions/Immunization", - "ImmunizationEvaluation": "#/definitions/ImmunizationEvaluation", - "ImmunizationRecommendation": "#/definitions/ImmunizationRecommendation", - "ImplementationGuide": "#/definitions/ImplementationGuide", - "InsurancePlan": "#/definitions/InsurancePlan", - "Invoice": "#/definitions/Invoice", - "Library": "#/definitions/Library", - "Linkage": "#/definitions/Linkage", - "List": "#/definitions/List", - "Location": "#/definitions/Location", - "Measure": "#/definitions/Measure", - "MeasureReport": "#/definitions/MeasureReport", - "Media": "#/definitions/Media", - "Medication": "#/definitions/Medication", - "MedicationAdministration": "#/definitions/MedicationAdministration", - "MedicationDispense": "#/definitions/MedicationDispense", - "MedicationKnowledge": "#/definitions/MedicationKnowledge", - "MedicationRequest": "#/definitions/MedicationRequest", - "MedicationStatement": "#/definitions/MedicationStatement", - "MedicinalProduct": "#/definitions/MedicinalProduct", - "MedicinalProductAuthorization": "#/definitions/MedicinalProductAuthorization", - "MedicinalProductContraindication": "#/definitions/MedicinalProductContraindication", - "MedicinalProductIndication": "#/definitions/MedicinalProductIndication", - "MedicinalProductIngredient": "#/definitions/MedicinalProductIngredient", - "MedicinalProductInteraction": "#/definitions/MedicinalProductInteraction", - "MedicinalProductManufactured": "#/definitions/MedicinalProductManufactured", - "MedicinalProductPackaged": "#/definitions/MedicinalProductPackaged", - "MedicinalProductPharmaceutical": "#/definitions/MedicinalProductPharmaceutical", - "MedicinalProductUndesirableEffect": "#/definitions/MedicinalProductUndesirableEffect", - "MessageDefinition": "#/definitions/MessageDefinition", - "MessageHeader": "#/definitions/MessageHeader", - "MolecularSequence": "#/definitions/MolecularSequence", - "NamingSystem": "#/definitions/NamingSystem", - "NutritionOrder": "#/definitions/NutritionOrder", - "Observation": "#/definitions/Observation", - "ObservationDefinition": "#/definitions/ObservationDefinition", - "OperationDefinition": "#/definitions/OperationDefinition", - "OperationOutcome": "#/definitions/OperationOutcome", - "Organization": "#/definitions/Organization", - "OrganizationAffiliation": "#/definitions/OrganizationAffiliation", - "Parameters": "#/definitions/Parameters", - "Patient": "#/definitions/Patient", - "PaymentNotice": "#/definitions/PaymentNotice", - "PaymentReconciliation": "#/definitions/PaymentReconciliation", - "Person": "#/definitions/Person", - "PlanDefinition": "#/definitions/PlanDefinition", - "Practitioner": "#/definitions/Practitioner", - "PractitionerRole": "#/definitions/PractitionerRole", - "Procedure": "#/definitions/Procedure", - "Provenance": "#/definitions/Provenance", - "Questionnaire": "#/definitions/Questionnaire", - "QuestionnaireResponse": "#/definitions/QuestionnaireResponse", - "RelatedPerson": "#/definitions/RelatedPerson", - "RequestGroup": "#/definitions/RequestGroup", - "ResearchDefinition": "#/definitions/ResearchDefinition", - "ResearchElementDefinition": "#/definitions/ResearchElementDefinition", - "ResearchStudy": "#/definitions/ResearchStudy", - "ResearchSubject": "#/definitions/ResearchSubject", - "RiskAssessment": "#/definitions/RiskAssessment", - "RiskEvidenceSynthesis": "#/definitions/RiskEvidenceSynthesis", - "Schedule": "#/definitions/Schedule", - "SearchParameter": "#/definitions/SearchParameter", - "ServiceRequest": "#/definitions/ServiceRequest", - "Slot": "#/definitions/Slot", - "Specimen": "#/definitions/Specimen", - "SpecimenDefinition": "#/definitions/SpecimenDefinition", - "StructureDefinition": "#/definitions/StructureDefinition", - "StructureMap": "#/definitions/StructureMap", - "Subscription": "#/definitions/Subscription", - "Substance": "#/definitions/Substance", - "SubstanceNucleicAcid": "#/definitions/SubstanceNucleicAcid", - "SubstancePolymer": "#/definitions/SubstancePolymer", - "SubstanceProtein": "#/definitions/SubstanceProtein", - "SubstanceReferenceInformation": "#/definitions/SubstanceReferenceInformation", - "SubstanceSourceMaterial": "#/definitions/SubstanceSourceMaterial", - "SubstanceSpecification": "#/definitions/SubstanceSpecification", - "SupplyDelivery": "#/definitions/SupplyDelivery", - "SupplyRequest": "#/definitions/SupplyRequest", - "Task": "#/definitions/Task", - "TerminologyCapabilities": "#/definitions/TerminologyCapabilities", - "TestReport": "#/definitions/TestReport", - "TestScript": "#/definitions/TestScript", - "ValueSet": "#/definitions/ValueSet", - "VerificationResult": "#/definitions/VerificationResult", - "VisionPrescription": "#/definitions/VisionPrescription" - } - }, - "oneOf": [ - { - "$ref": "#/definitions/Account" - }, - { - "$ref": "#/definitions/ActivityDefinition" - }, - { - "$ref": "#/definitions/AdverseEvent" - }, - { - "$ref": "#/definitions/AllergyIntolerance" - }, - { - "$ref": "#/definitions/Appointment" - }, - { - "$ref": "#/definitions/AppointmentResponse" - }, - { - "$ref": "#/definitions/AuditEvent" - }, - { - "$ref": "#/definitions/Basic" - }, - { - "$ref": "#/definitions/Binary" - }, - { - "$ref": "#/definitions/BiologicallyDerivedProduct" - }, - { - "$ref": "#/definitions/BodyStructure" - }, - { - "$ref": "#/definitions/Bundle" - }, - { - "$ref": "#/definitions/CapabilityStatement" - }, - { - "$ref": "#/definitions/CarePlan" - }, - { - "$ref": "#/definitions/CareTeam" - }, - { - "$ref": "#/definitions/CatalogEntry" - }, - { - "$ref": "#/definitions/ChargeItem" - }, - { - "$ref": "#/definitions/ChargeItemDefinition" - }, - { - "$ref": "#/definitions/Claim" - }, - { - "$ref": "#/definitions/ClaimResponse" - }, - { - "$ref": "#/definitions/ClinicalImpression" - }, - { - "$ref": "#/definitions/CodeSystem" - }, - { - "$ref": "#/definitions/Communication" - }, - { - "$ref": "#/definitions/CommunicationRequest" - }, - { - "$ref": "#/definitions/CompartmentDefinition" - }, - { - "$ref": "#/definitions/Composition" - }, - { - "$ref": "#/definitions/ConceptMap" - }, - { - "$ref": "#/definitions/Condition" - }, - { - "$ref": "#/definitions/Consent" - }, - { - "$ref": "#/definitions/Contract" - }, - { - "$ref": "#/definitions/Coverage" - }, - { - "$ref": "#/definitions/CoverageEligibilityRequest" - }, - { - "$ref": "#/definitions/CoverageEligibilityResponse" - }, - { - "$ref": "#/definitions/DetectedIssue" - }, - { - "$ref": "#/definitions/Device" - }, - { - "$ref": "#/definitions/DeviceDefinition" - }, - { - "$ref": "#/definitions/DeviceMetric" - }, - { - "$ref": "#/definitions/DeviceRequest" - }, - { - "$ref": "#/definitions/DeviceUseStatement" - }, - { - "$ref": "#/definitions/DiagnosticReport" - }, - { - "$ref": "#/definitions/DocumentManifest" - }, - { - "$ref": "#/definitions/DocumentReference" - }, - { - "$ref": "#/definitions/EffectEvidenceSynthesis" - }, - { - "$ref": "#/definitions/Encounter" - }, - { - "$ref": "#/definitions/Endpoint" - }, - { - "$ref": "#/definitions/EnrollmentRequest" - }, - { - "$ref": "#/definitions/EnrollmentResponse" - }, - { - "$ref": "#/definitions/EpisodeOfCare" - }, - { - "$ref": "#/definitions/EventDefinition" - }, - { - "$ref": "#/definitions/Evidence" - }, - { - "$ref": "#/definitions/EvidenceVariable" - }, - { - "$ref": "#/definitions/ExampleScenario" - }, - { - "$ref": "#/definitions/ExplanationOfBenefit" - }, - { - "$ref": "#/definitions/FamilyMemberHistory" - }, - { - "$ref": "#/definitions/Flag" - }, - { - "$ref": "#/definitions/Goal" - }, - { - "$ref": "#/definitions/GraphDefinition" - }, - { - "$ref": "#/definitions/Group" - }, - { - "$ref": "#/definitions/GuidanceResponse" - }, - { - "$ref": "#/definitions/HealthcareService" - }, - { - "$ref": "#/definitions/ImagingStudy" - }, - { - "$ref": "#/definitions/Immunization" - }, - { - "$ref": "#/definitions/ImmunizationEvaluation" - }, - { - "$ref": "#/definitions/ImmunizationRecommendation" - }, - { - "$ref": "#/definitions/ImplementationGuide" - }, - { - "$ref": "#/definitions/InsurancePlan" - }, - { - "$ref": "#/definitions/Invoice" - }, - { - "$ref": "#/definitions/Library" - }, - { - "$ref": "#/definitions/Linkage" - }, - { - "$ref": "#/definitions/List" - }, - { - "$ref": "#/definitions/Location" - }, - { - "$ref": "#/definitions/Measure" - }, - { - "$ref": "#/definitions/MeasureReport" - }, - { - "$ref": "#/definitions/Media" - }, - { - "$ref": "#/definitions/Medication" - }, - { - "$ref": "#/definitions/MedicationAdministration" - }, - { - "$ref": "#/definitions/MedicationDispense" - }, - { - "$ref": "#/definitions/MedicationKnowledge" - }, - { - "$ref": "#/definitions/MedicationRequest" - }, - { - "$ref": "#/definitions/MedicationStatement" - }, - { - "$ref": "#/definitions/MedicinalProduct" - }, - { - "$ref": "#/definitions/MedicinalProductAuthorization" - }, - { - "$ref": "#/definitions/MedicinalProductContraindication" - }, - { - "$ref": "#/definitions/MedicinalProductIndication" - }, - { - "$ref": "#/definitions/MedicinalProductIngredient" - }, - { - "$ref": "#/definitions/MedicinalProductInteraction" - }, - { - "$ref": "#/definitions/MedicinalProductManufactured" - }, - { - "$ref": "#/definitions/MedicinalProductPackaged" - }, - { - "$ref": "#/definitions/MedicinalProductPharmaceutical" - }, - { - "$ref": "#/definitions/MedicinalProductUndesirableEffect" - }, - { - "$ref": "#/definitions/MessageDefinition" - }, - { - "$ref": "#/definitions/MessageHeader" - }, - { - "$ref": "#/definitions/MolecularSequence" - }, - { - "$ref": "#/definitions/NamingSystem" - }, - { - "$ref": "#/definitions/NutritionOrder" - }, - { - "$ref": "#/definitions/Observation" - }, - { - "$ref": "#/definitions/ObservationDefinition" - }, - { - "$ref": "#/definitions/OperationDefinition" - }, - { - "$ref": "#/definitions/OperationOutcome" - }, - { - "$ref": "#/definitions/Organization" - }, - { - "$ref": "#/definitions/OrganizationAffiliation" - }, - { - "$ref": "#/definitions/Parameters" - }, - { - "$ref": "#/definitions/Patient" - }, - { - "$ref": "#/definitions/PaymentNotice" - }, - { - "$ref": "#/definitions/PaymentReconciliation" - }, - { - "$ref": "#/definitions/Person" - }, - { - "$ref": "#/definitions/PlanDefinition" - }, - { - "$ref": "#/definitions/Practitioner" - }, - { - "$ref": "#/definitions/PractitionerRole" - }, - { - "$ref": "#/definitions/Procedure" - }, - { - "$ref": "#/definitions/Provenance" - }, - { - "$ref": "#/definitions/Questionnaire" - }, - { - "$ref": "#/definitions/QuestionnaireResponse" - }, - { - "$ref": "#/definitions/RelatedPerson" - }, - { - "$ref": "#/definitions/RequestGroup" - }, - { - "$ref": "#/definitions/ResearchDefinition" - }, - { - "$ref": "#/definitions/ResearchElementDefinition" - }, - { - "$ref": "#/definitions/ResearchStudy" - }, - { - "$ref": "#/definitions/ResearchSubject" - }, - { - "$ref": "#/definitions/RiskAssessment" - }, - { - "$ref": "#/definitions/RiskEvidenceSynthesis" - }, - { - "$ref": "#/definitions/Schedule" - }, - { - "$ref": "#/definitions/SearchParameter" - }, - { - "$ref": "#/definitions/ServiceRequest" - }, - { - "$ref": "#/definitions/Slot" - }, - { - "$ref": "#/definitions/Specimen" - }, - { - "$ref": "#/definitions/SpecimenDefinition" - }, - { - "$ref": "#/definitions/StructureDefinition" - }, - { - "$ref": "#/definitions/StructureMap" - }, - { - "$ref": "#/definitions/Subscription" - }, - { - "$ref": "#/definitions/Substance" - }, - { - "$ref": "#/definitions/SubstanceNucleicAcid" - }, - { - "$ref": "#/definitions/SubstancePolymer" - }, - { - "$ref": "#/definitions/SubstanceProtein" - }, - { - "$ref": "#/definitions/SubstanceReferenceInformation" - }, - { - "$ref": "#/definitions/SubstanceSourceMaterial" - }, - { - "$ref": "#/definitions/SubstanceSpecification" - }, - { - "$ref": "#/definitions/SupplyDelivery" - }, - { - "$ref": "#/definitions/SupplyRequest" - }, - { - "$ref": "#/definitions/Task" - }, - { - "$ref": "#/definitions/TerminologyCapabilities" - }, - { - "$ref": "#/definitions/TestReport" - }, - { - "$ref": "#/definitions/TestScript" - }, - { - "$ref": "#/definitions/ValueSet" - }, - { - "$ref": "#/definitions/VerificationResult" - }, - { - "$ref": "#/definitions/VisionPrescription" - } - ], - "definitions": { - "ResourceList": { - "oneOf": [ - { - "$ref": "#/definitions/Account" - }, - { - "$ref": "#/definitions/ActivityDefinition" - }, - { - "$ref": "#/definitions/AdverseEvent" - }, - { - "$ref": "#/definitions/AllergyIntolerance" - }, - { - "$ref": "#/definitions/Appointment" - }, - { - "$ref": "#/definitions/AppointmentResponse" - }, - { - "$ref": "#/definitions/AuditEvent" - }, - { - "$ref": "#/definitions/Basic" - }, - { - "$ref": "#/definitions/Binary" - }, - { - "$ref": "#/definitions/BiologicallyDerivedProduct" - }, - { - "$ref": "#/definitions/BodyStructure" - }, - { - "$ref": "#/definitions/Bundle" - }, - { - "$ref": "#/definitions/CapabilityStatement" - }, - { - "$ref": "#/definitions/CarePlan" - }, - { - "$ref": "#/definitions/CareTeam" - }, - { - "$ref": "#/definitions/CatalogEntry" - }, - { - "$ref": "#/definitions/ChargeItem" - }, - { - "$ref": "#/definitions/ChargeItemDefinition" - }, - { - "$ref": "#/definitions/Claim" - }, - { - "$ref": "#/definitions/ClaimResponse" - }, - { - "$ref": "#/definitions/ClinicalImpression" - }, - { - "$ref": "#/definitions/CodeSystem" - }, - { - "$ref": "#/definitions/Communication" - }, - { - "$ref": "#/definitions/CommunicationRequest" - }, - { - "$ref": "#/definitions/CompartmentDefinition" - }, - { - "$ref": "#/definitions/Composition" - }, - { - "$ref": "#/definitions/ConceptMap" - }, - { - "$ref": "#/definitions/Condition" - }, - { - "$ref": "#/definitions/Consent" - }, - { - "$ref": "#/definitions/Contract" - }, - { - "$ref": "#/definitions/Coverage" - }, - { - "$ref": "#/definitions/CoverageEligibilityRequest" - }, - { - "$ref": "#/definitions/CoverageEligibilityResponse" - }, - { - "$ref": "#/definitions/DetectedIssue" - }, - { - "$ref": "#/definitions/Device" - }, - { - "$ref": "#/definitions/DeviceDefinition" - }, - { - "$ref": "#/definitions/DeviceMetric" - }, - { - "$ref": "#/definitions/DeviceRequest" - }, - { - "$ref": "#/definitions/DeviceUseStatement" - }, - { - "$ref": "#/definitions/DiagnosticReport" - }, - { - "$ref": "#/definitions/DocumentManifest" - }, - { - "$ref": "#/definitions/DocumentReference" - }, - { - "$ref": "#/definitions/EffectEvidenceSynthesis" - }, - { - "$ref": "#/definitions/Encounter" - }, - { - "$ref": "#/definitions/Endpoint" - }, - { - "$ref": "#/definitions/EnrollmentRequest" - }, - { - "$ref": "#/definitions/EnrollmentResponse" - }, - { - "$ref": "#/definitions/EpisodeOfCare" - }, - { - "$ref": "#/definitions/EventDefinition" - }, - { - "$ref": "#/definitions/Evidence" - }, - { - "$ref": "#/definitions/EvidenceVariable" - }, - { - "$ref": "#/definitions/ExampleScenario" - }, - { - "$ref": "#/definitions/ExplanationOfBenefit" - }, - { - "$ref": "#/definitions/FamilyMemberHistory" - }, - { - "$ref": "#/definitions/Flag" - }, - { - "$ref": "#/definitions/Goal" - }, - { - "$ref": "#/definitions/GraphDefinition" - }, - { - "$ref": "#/definitions/Group" - }, - { - "$ref": "#/definitions/GuidanceResponse" - }, - { - "$ref": "#/definitions/HealthcareService" - }, - { - "$ref": "#/definitions/ImagingStudy" - }, - { - "$ref": "#/definitions/Immunization" - }, - { - "$ref": "#/definitions/ImmunizationEvaluation" - }, - { - "$ref": "#/definitions/ImmunizationRecommendation" - }, - { - "$ref": "#/definitions/ImplementationGuide" - }, - { - "$ref": "#/definitions/InsurancePlan" - }, - { - "$ref": "#/definitions/Invoice" - }, - { - "$ref": "#/definitions/Library" - }, - { - "$ref": "#/definitions/Linkage" - }, - { - "$ref": "#/definitions/List" - }, - { - "$ref": "#/definitions/Location" - }, - { - "$ref": "#/definitions/Measure" - }, - { - "$ref": "#/definitions/MeasureReport" - }, - { - "$ref": "#/definitions/Media" - }, - { - "$ref": "#/definitions/Medication" - }, - { - "$ref": "#/definitions/MedicationAdministration" - }, - { - "$ref": "#/definitions/MedicationDispense" - }, - { - "$ref": "#/definitions/MedicationKnowledge" - }, - { - "$ref": "#/definitions/MedicationRequest" - }, - { - "$ref": "#/definitions/MedicationStatement" - }, - { - "$ref": "#/definitions/MedicinalProduct" - }, - { - "$ref": "#/definitions/MedicinalProductAuthorization" - }, - { - "$ref": "#/definitions/MedicinalProductContraindication" - }, - { - "$ref": "#/definitions/MedicinalProductIndication" - }, - { - "$ref": "#/definitions/MedicinalProductIngredient" - }, - { - "$ref": "#/definitions/MedicinalProductInteraction" - }, - { - "$ref": "#/definitions/MedicinalProductManufactured" - }, - { - "$ref": "#/definitions/MedicinalProductPackaged" - }, - { - "$ref": "#/definitions/MedicinalProductPharmaceutical" - }, - { - "$ref": "#/definitions/MedicinalProductUndesirableEffect" - }, - { - "$ref": "#/definitions/MessageDefinition" - }, - { - "$ref": "#/definitions/MessageHeader" - }, - { - "$ref": "#/definitions/MolecularSequence" - }, - { - "$ref": "#/definitions/NamingSystem" - }, - { - "$ref": "#/definitions/NutritionOrder" - }, - { - "$ref": "#/definitions/Observation" - }, - { - "$ref": "#/definitions/ObservationDefinition" - }, - { - "$ref": "#/definitions/OperationDefinition" - }, - { - "$ref": "#/definitions/OperationOutcome" - }, - { - "$ref": "#/definitions/Organization" - }, - { - "$ref": "#/definitions/OrganizationAffiliation" - }, - { - "$ref": "#/definitions/Parameters" - }, - { - "$ref": "#/definitions/Patient" - }, - { - "$ref": "#/definitions/PaymentNotice" - }, - { - "$ref": "#/definitions/PaymentReconciliation" - }, - { - "$ref": "#/definitions/Person" - }, - { - "$ref": "#/definitions/PlanDefinition" - }, - { - "$ref": "#/definitions/Practitioner" - }, - { - "$ref": "#/definitions/PractitionerRole" - }, - { - "$ref": "#/definitions/Procedure" - }, - { - "$ref": "#/definitions/Provenance" - }, - { - "$ref": "#/definitions/Questionnaire" - }, - { - "$ref": "#/definitions/QuestionnaireResponse" - }, - { - "$ref": "#/definitions/RelatedPerson" - }, - { - "$ref": "#/definitions/RequestGroup" - }, - { - "$ref": "#/definitions/ResearchDefinition" - }, - { - "$ref": "#/definitions/ResearchElementDefinition" - }, - { - "$ref": "#/definitions/ResearchStudy" - }, - { - "$ref": "#/definitions/ResearchSubject" - }, - { - "$ref": "#/definitions/RiskAssessment" - }, - { - "$ref": "#/definitions/RiskEvidenceSynthesis" - }, - { - "$ref": "#/definitions/Schedule" - }, - { - "$ref": "#/definitions/SearchParameter" - }, - { - "$ref": "#/definitions/ServiceRequest" - }, - { - "$ref": "#/definitions/Slot" - }, - { - "$ref": "#/definitions/Specimen" - }, - { - "$ref": "#/definitions/SpecimenDefinition" - }, - { - "$ref": "#/definitions/StructureDefinition" - }, - { - "$ref": "#/definitions/StructureMap" - }, - { - "$ref": "#/definitions/Subscription" - }, - { - "$ref": "#/definitions/Substance" - }, - { - "$ref": "#/definitions/SubstanceNucleicAcid" - }, - { - "$ref": "#/definitions/SubstancePolymer" - }, - { - "$ref": "#/definitions/SubstanceProtein" - }, - { - "$ref": "#/definitions/SubstanceReferenceInformation" - }, - { - "$ref": "#/definitions/SubstanceSourceMaterial" - }, - { - "$ref": "#/definitions/SubstanceSpecification" - }, - { - "$ref": "#/definitions/SupplyDelivery" - }, - { - "$ref": "#/definitions/SupplyRequest" - }, - { - "$ref": "#/definitions/Task" - }, - { - "$ref": "#/definitions/TerminologyCapabilities" - }, - { - "$ref": "#/definitions/TestReport" - }, - { - "$ref": "#/definitions/TestScript" - }, - { - "$ref": "#/definitions/ValueSet" - }, - { - "$ref": "#/definitions/VerificationResult" - }, - { - "$ref": "#/definitions/VisionPrescription" - } - ] - }, - "base64Binary": { - "type": "string", - "description": "A stream of bytes" - }, - "boolean": { - "pattern": "^true|false$", - "type": "boolean", - "description": "Value of \"true\" or \"false\"" - }, - "canonical": { - "pattern": "^\\S*$", - "type": "string", - "description": "A URI that is a reference to a canonical URL on a FHIR resource" - }, - "code": { - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string", - "description": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents" - }, - "date": { - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string", - "description": "A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates." - }, - "dateTime": { - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string", - "description": "A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates." - }, - "decimal": { - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number", - "description": "A rational number with implicit precision" - }, - "id": { - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string", - "description": "Any combination of letters, numerals, \"-\" and \".\", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive." - }, - "instant": { - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string", - "description": "An instant in time - known at least to the second" - }, - "integer": { - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number", - "description": "A whole number" - }, - "markdown": { - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string", - "description": "A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine" - }, - "oid": { - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string", - "description": "An OID represented as a URI" - }, - "positiveInt": { - "pattern": "^[1-9][0-9]*$", - "type": "number", - "description": "An integer with a value that is positive (e.g. \u003e0)" - }, - "string": { - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string", - "description": "A sequence of Unicode characters" - }, - "time": { - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string", - "description": "A time during the day, with no date specified" - }, - "unsignedInt": { - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number", - "description": "An integer with a value that is not negative (e.g. \u003e\u003d 0)" - }, - "uri": { - "pattern": "^\\S*$", - "type": "string", - "description": "String of characters used to identify a name or a resource" - }, - "url": { - "pattern": "^\\S*$", - "type": "string", - "description": "A URI that is a literal reference" - }, - "uuid": { - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string", - "description": "A UUID, represented as a URI" - }, - "xhtml": { - "description": "xhtml - escaped html (see specfication)" - }, - "Element": { - "description": "Base definition for all elements in a resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Extension": { - "description": "Optional Extension Element - found in all resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "Source of the definition for the extension code - a logical name or a URL.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "valueBase64Binary": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueCanonical": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueCanonical": { - "description": "Extensions for valueCanonical", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueId": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueInstant": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_valueInstant": { - "description": "Extensions for valueInstant", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueMarkdown": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueMarkdown": { - "description": "Extensions for valueMarkdown", - "$ref": "#/definitions/Element" - }, - "valueOid": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_valueOid": { - "description": "Extensions for valueOid", - "$ref": "#/definitions/Element" - }, - "valuePositiveInt": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_valuePositiveInt": { - "description": "Extensions for valuePositiveInt", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueUnsignedInt": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_valueUnsignedInt": { - "description": "Extensions for valueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueUrl": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUrl": { - "description": "Extensions for valueUrl", - "$ref": "#/definitions/Element" - }, - "valueUuid": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_valueUuid": { - "description": "Extensions for valueUuid", - "$ref": "#/definitions/Element" - }, - "valueAddress": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Address" - }, - "valueAge": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Age" - }, - "valueAnnotation": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Annotation" - }, - "valueAttachment": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Attachment" - }, - "valueCodeableConcept": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCoding": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Coding" - }, - "valueContactPoint": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/ContactPoint" - }, - "valueCount": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Count" - }, - "valueDistance": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Distance" - }, - "valueDuration": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Duration" - }, - "valueHumanName": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/HumanName" - }, - "valueIdentifier": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Identifier" - }, - "valueMoney": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Money" - }, - "valuePeriod": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Period" - }, - "valueQuantity": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Ratio" - }, - "valueReference": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Reference" - }, - "valueSampledData": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/SampledData" - }, - "valueSignature": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Signature" - }, - "valueTiming": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Timing" - }, - "valueContactDetail": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/ContactDetail" - }, - "valueContributor": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Contributor" - }, - "valueDataRequirement": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/DataRequirement" - }, - "valueExpression": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Expression" - }, - "valueParameterDefinition": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/ParameterDefinition" - }, - "valueRelatedArtifact": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/RelatedArtifact" - }, - "valueTriggerDefinition": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/TriggerDefinition" - }, - "valueUsageContext": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/UsageContext" - }, - "valueDosage": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Dosage" - }, - "valueMeta": { - "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", - "$ref": "#/definitions/Meta" - } - }, - "additionalProperties": false - }, - "Narrative": { - "description": "A human-readable summary of the resource conveying the essential clinical and business information for the resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "status": { - "description": "The status of the narrative - whether it\u0027s entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.", - "enum": [ - "generated", - "extensions", - "additional", - "empty" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "div": { - "description": "The actual narrative content, a stripped down version of XHTML.", - "$ref": "#/definitions/xhtml" - } - }, - "additionalProperties": false, - "required": [ - "div" - ] - }, - "Annotation": { - "description": "A text note which also contains information about who made the statement and when.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "authorReference": { - "description": "The individual responsible for making the annotation.", - "$ref": "#/definitions/Reference" - }, - "authorString": { - "description": "The individual responsible for making the annotation.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_authorString": { - "description": "Extensions for authorString", - "$ref": "#/definitions/Element" - }, - "time": { - "description": "Indicates when this particular annotation was made.", - "$ref": "#/definitions/dateTime" - }, - "_time": { - "description": "Extensions for time", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "The text of the annotation in markdown format.", - "$ref": "#/definitions/markdown" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Attachment": { - "description": "For referring to data content defined in other formats.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentType": { - "description": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", - "$ref": "#/definitions/code" - }, - "_contentType": { - "description": "Extensions for contentType", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The human language of the content. The value can be any valid value according to BCP 47.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "data": { - "description": "The actual data of the attachment - a sequence of bytes, base64 encoded.", - "$ref": "#/definitions/base64Binary" - }, - "_data": { - "description": "Extensions for data", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "A location where the data can be accessed.", - "$ref": "#/definitions/url" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "size": { - "description": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", - "$ref": "#/definitions/unsignedInt" - }, - "_size": { - "description": "Extensions for size", - "$ref": "#/definitions/Element" - }, - "hash": { - "description": "The calculated hash of the data using SHA-1. Represented using base64.", - "$ref": "#/definitions/base64Binary" - }, - "_hash": { - "description": "Extensions for hash", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A label or set of text to display in place of the data.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "creation": { - "description": "The date that the attachment was first created.", - "$ref": "#/definitions/dateTime" - }, - "_creation": { - "description": "Extensions for creation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Identifier": { - "description": "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "use": { - "description": "The purpose of this identifier.", - "enum": [ - "usual", - "official", - "temp", - "secondary", - "old" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", - "$ref": "#/definitions/CodeableConcept" - }, - "system": { - "description": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Time period during which identifier is/was valid for use.", - "$ref": "#/definitions/Period" - }, - "assigner": { - "description": "Organization that issued/manages the identifier.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "CodeableConcept": { - "description": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "coding": { - "description": "A reference to a code defined by a terminology system.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "text": { - "description": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Coding": { - "description": "A reference to a code defined by a terminology system.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "system": { - "description": "The identification of the code system that defines the meaning of the symbol in the code.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "A representation of the meaning of the code in the system, following the rules of the system.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "userSelected": { - "description": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", - "$ref": "#/definitions/boolean" - }, - "_userSelected": { - "description": "Extensions for userSelected", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Quantity": { - "description": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"\u003c\" , then the real value is \u003c stated value.", - "enum": [ - "\u003c", - "\u003c\u003d", - "\u003e\u003d", - "\u003e" - ] - }, - "_comparator": { - "description": "Extensions for comparator", - "$ref": "#/definitions/Element" - }, - "unit": { - "description": "A human-readable form of the unit.", - "$ref": "#/definitions/string" - }, - "_unit": { - "description": "Extensions for unit", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Duration": { - "description": "A length of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"\u003c\" , then the real value is \u003c stated value.", - "enum": [ - "\u003c", - "\u003c\u003d", - "\u003e\u003d", - "\u003e" - ] - }, - "_comparator": { - "description": "Extensions for comparator", - "$ref": "#/definitions/Element" - }, - "unit": { - "description": "A human-readable form of the unit.", - "$ref": "#/definitions/string" - }, - "_unit": { - "description": "Extensions for unit", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Distance": { - "description": "A length - a value with a unit that is a physical distance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"\u003c\" , then the real value is \u003c stated value.", - "enum": [ - "\u003c", - "\u003c\u003d", - "\u003e\u003d", - "\u003e" - ] - }, - "_comparator": { - "description": "Extensions for comparator", - "$ref": "#/definitions/Element" - }, - "unit": { - "description": "A human-readable form of the unit.", - "$ref": "#/definitions/string" - }, - "_unit": { - "description": "Extensions for unit", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Count": { - "description": "A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"\u003c\" , then the real value is \u003c stated value.", - "enum": [ - "\u003c", - "\u003c\u003d", - "\u003e\u003d", - "\u003e" - ] - }, - "_comparator": { - "description": "Extensions for comparator", - "$ref": "#/definitions/Element" - }, - "unit": { - "description": "A human-readable form of the unit.", - "$ref": "#/definitions/string" - }, - "_unit": { - "description": "Extensions for unit", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Money": { - "description": "An amount of economic utility in some recognized currency.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "Numerical value (with implicit precision).", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "currency": { - "description": "ISO 4217 Currency Code.", - "$ref": "#/definitions/code" - }, - "_currency": { - "description": "Extensions for currency", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Age": { - "description": "A duration of time during which an organism (or a process) has existed.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"\u003c\" , then the real value is \u003c stated value.", - "enum": [ - "\u003c", - "\u003c\u003d", - "\u003e\u003d", - "\u003e" - ] - }, - "_comparator": { - "description": "Extensions for comparator", - "$ref": "#/definitions/Element" - }, - "unit": { - "description": "A human-readable form of the unit.", - "$ref": "#/definitions/string" - }, - "_unit": { - "description": "Extensions for unit", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Range": { - "description": "A set of ordered Quantities defined by a low and high limit.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "low": { - "description": "The low limit. The boundary is inclusive.", - "$ref": "#/definitions/Quantity" - }, - "high": { - "description": "The high limit. The boundary is inclusive.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Period": { - "description": "A time period defined by a start and end date and optionally time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "start": { - "description": "The start of the period. The boundary is inclusive.", - "$ref": "#/definitions/dateTime" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", - "$ref": "#/definitions/dateTime" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Ratio": { - "description": "A relationship of two Quantity values - expressed as a numerator and a denominator.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "numerator": { - "description": "The value of the numerator.", - "$ref": "#/definitions/Quantity" - }, - "denominator": { - "description": "The value of the denominator.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Reference": { - "description": "A reference from one resource to another.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with \u0027#\u0027) refer to contained resources.", - "$ref": "#/definitions/string" - }, - "_reference": { - "description": "Extensions for reference", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", - "$ref": "#/definitions/uri" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", - "$ref": "#/definitions/Identifier" - }, - "display": { - "description": "Plain text narrative that identifies the resource in addition to the resource reference.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SampledData": { - "description": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "origin": { - "description": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.", - "$ref": "#/definitions/Quantity" - }, - "period": { - "description": "The length of time between sampling times, measured in milliseconds.", - "$ref": "#/definitions/decimal" - }, - "_period": { - "description": "Extensions for period", - "$ref": "#/definitions/Element" - }, - "factor": { - "description": "A correction factor that is applied to the sampled data points before they are added to the origin.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "lowerLimit": { - "description": "The lower limit of detection of the measured points. This is needed if any of the data points have the value \"L\" (lower than detection limit).", - "$ref": "#/definitions/decimal" - }, - "_lowerLimit": { - "description": "Extensions for lowerLimit", - "$ref": "#/definitions/Element" - }, - "upperLimit": { - "description": "The upper limit of detection of the measured points. This is needed if any of the data points have the value \"U\" (higher than detection limit).", - "$ref": "#/definitions/decimal" - }, - "_upperLimit": { - "description": "Extensions for upperLimit", - "$ref": "#/definitions/Element" - }, - "dimensions": { - "description": "The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.", - "$ref": "#/definitions/positiveInt" - }, - "_dimensions": { - "description": "Extensions for dimensions", - "$ref": "#/definitions/Element" - }, - "data": { - "description": "A series of data points which are decimal values separated by a single space (character u20). The special values \"E\" (error), \"L\" (below detection limit) and \"U\" (above detection limit) can also be used in place of a decimal value.", - "$ref": "#/definitions/string" - }, - "_data": { - "description": "Extensions for data", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "origin" - ] - }, - "Signature": { - "description": "A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "when": { - "description": "When the digital signature was signed.", - "$ref": "#/definitions/instant" - }, - "_when": { - "description": "Extensions for when", - "$ref": "#/definitions/Element" - }, - "who": { - "description": "A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).", - "$ref": "#/definitions/Reference" - }, - "onBehalfOf": { - "description": "A reference to an application-usable description of the identity that is represented by the signature.", - "$ref": "#/definitions/Reference" - }, - "targetFormat": { - "description": "A mime type that indicates the technical format of the target resources signed by the signature.", - "$ref": "#/definitions/code" - }, - "_targetFormat": { - "description": "Extensions for targetFormat", - "$ref": "#/definitions/Element" - }, - "sigFormat": { - "description": "A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", - "$ref": "#/definitions/code" - }, - "_sigFormat": { - "description": "Extensions for sigFormat", - "$ref": "#/definitions/Element" - }, - "data": { - "description": "The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", - "$ref": "#/definitions/base64Binary" - }, - "_data": { - "description": "Extensions for data", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "type", - "who" - ] - }, - "HumanName": { - "description": "A human\u0027s name with the ability to identify parts and usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "use": { - "description": "Identifies the purpose for this name.", - "enum": [ - "usual", - "official", - "temp", - "nickname", - "anonymous", - "old", - "maiden" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "family": { - "description": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", - "$ref": "#/definitions/string" - }, - "_family": { - "description": "Extensions for family", - "$ref": "#/definitions/Element" - }, - "given": { - "description": "Given name.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_given": { - "description": "Extensions for given", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "prefix": { - "description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_prefix": { - "description": "Extensions for prefix", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "suffix": { - "description": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_suffix": { - "description": "Extensions for suffix", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "period": { - "description": "Indicates the period of time when this name was valid for the named person.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "Address": { - "description": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "use": { - "description": "The purpose of this address.", - "enum": [ - "home", - "work", - "temp", - "old", - "billing" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", - "enum": [ - "postal", - "physical", - "both" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "line": { - "description": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_line": { - "description": "Extensions for line", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "city": { - "description": "The name of the city, town, suburb, village or other community or delivery center.", - "$ref": "#/definitions/string" - }, - "_city": { - "description": "Extensions for city", - "$ref": "#/definitions/Element" - }, - "district": { - "description": "The name of the administrative area (county).", - "$ref": "#/definitions/string" - }, - "_district": { - "description": "Extensions for district", - "$ref": "#/definitions/Element" - }, - "state": { - "description": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", - "$ref": "#/definitions/string" - }, - "_state": { - "description": "Extensions for state", - "$ref": "#/definitions/Element" - }, - "postalCode": { - "description": "A postal code designating a region defined by the postal service.", - "$ref": "#/definitions/string" - }, - "_postalCode": { - "description": "Extensions for postalCode", - "$ref": "#/definitions/Element" - }, - "country": { - "description": "Country - a nation as commonly understood or generally accepted.", - "$ref": "#/definitions/string" - }, - "_country": { - "description": "Extensions for country", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Time period when address was/is in use.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "ContactPoint": { - "description": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "system": { - "description": "Telecommunications form for contact point - what communications system is required to make use of the contact.", - "enum": [ - "phone", - "fax", - "email", - "pager", - "url", - "sms", - "other" - ] - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "use": { - "description": "Identifies the purpose for the contact point.", - "enum": [ - "home", - "work", - "temp", - "old", - "mobile" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "rank": { - "description": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", - "$ref": "#/definitions/positiveInt" - }, - "_rank": { - "description": "Extensions for rank", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Time period when the contact point was/is in use.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "Timing": { - "description": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "event": { - "description": "Identifies specific times when the event occurs.", - "items": { - "$ref": "#/definitions/dateTime" - }, - "type": "array" - }, - "_event": { - "description": "Extensions for event", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "repeat": { - "description": "A set of rules that describe when the event is scheduled.", - "$ref": "#/definitions/Timing_Repeat" - }, - "code": { - "description": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "Timing_Repeat": { - "description": "Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "boundsDuration": { - "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", - "$ref": "#/definitions/Duration" - }, - "boundsRange": { - "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", - "$ref": "#/definitions/Range" - }, - "boundsPeriod": { - "description": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", - "$ref": "#/definitions/Period" - }, - "count": { - "description": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.", - "$ref": "#/definitions/positiveInt" - }, - "_count": { - "description": "Extensions for count", - "$ref": "#/definitions/Element" - }, - "countMax": { - "description": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.", - "$ref": "#/definitions/positiveInt" - }, - "_countMax": { - "description": "Extensions for countMax", - "$ref": "#/definitions/Element" - }, - "duration": { - "description": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.", - "$ref": "#/definitions/decimal" - }, - "_duration": { - "description": "Extensions for duration", - "$ref": "#/definitions/Element" - }, - "durationMax": { - "description": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.", - "$ref": "#/definitions/decimal" - }, - "_durationMax": { - "description": "Extensions for durationMax", - "$ref": "#/definitions/Element" - }, - "durationUnit": { - "description": "The units of time for the duration, in UCUM units.", - "enum": [ - "s", - "min", - "h", - "d", - "wk", - "mo", - "a" - ] - }, - "_durationUnit": { - "description": "Extensions for durationUnit", - "$ref": "#/definitions/Element" - }, - "frequency": { - "description": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.", - "$ref": "#/definitions/positiveInt" - }, - "_frequency": { - "description": "Extensions for frequency", - "$ref": "#/definitions/Element" - }, - "frequencyMax": { - "description": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.", - "$ref": "#/definitions/positiveInt" - }, - "_frequencyMax": { - "description": "Extensions for frequencyMax", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.", - "$ref": "#/definitions/decimal" - }, - "_period": { - "description": "Extensions for period", - "$ref": "#/definitions/Element" - }, - "periodMax": { - "description": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.", - "$ref": "#/definitions/decimal" - }, - "_periodMax": { - "description": "Extensions for periodMax", - "$ref": "#/definitions/Element" - }, - "periodUnit": { - "description": "The units of time for the period in UCUM units.", - "enum": [ - "s", - "min", - "h", - "d", - "wk", - "mo", - "a" - ] - }, - "_periodUnit": { - "description": "Extensions for periodUnit", - "$ref": "#/definitions/Element" - }, - "dayOfWeek": { - "description": "If one or more days of week is provided, then the action happens only on the specified day(s).", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_dayOfWeek": { - "description": "Extensions for dayOfWeek", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "timeOfDay": { - "description": "Specified time of day for action to take place.", - "items": { - "$ref": "#/definitions/time" - }, - "type": "array" - }, - "_timeOfDay": { - "description": "Extensions for timeOfDay", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "when": { - "description": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.", - "items": { - "enum": [ - "MORN", - "MORN.early", - "MORN.late", - "NOON", - "AFT", - "AFT.early", - "AFT.late", - "EVE", - "EVE.early", - "EVE.late", - "NIGHT", - "PHS", - "HS", - "WAKE", - "C", - "CM", - "CD", - "CV", - "AC", - "ACM", - "ACD", - "ACV", - "PC", - "PCM", - "PCD", - "PCV" - ] - }, - "type": "array" - }, - "_when": { - "description": "Extensions for when", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "offset": { - "description": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.", - "$ref": "#/definitions/unsignedInt" - }, - "_offset": { - "description": "Extensions for offset", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Meta": { - "description": "The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "versionId": { - "description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", - "$ref": "#/definitions/id" - }, - "_versionId": { - "description": "Extensions for versionId", - "$ref": "#/definitions/Element" - }, - "lastUpdated": { - "description": "When the resource last changed - e.g. when the version changed.", - "$ref": "#/definitions/instant" - }, - "_lastUpdated": { - "description": "Extensions for lastUpdated", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.", - "$ref": "#/definitions/uri" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "security": { - "description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "tag": { - "description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ContactDetail": { - "description": "Specifies contact information for a person or organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of an individual to contact.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "telecom": { - "description": "The contact details for the individual (if a name was provided) or the organization.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Contributor": { - "description": "A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of contributor.", - "enum": [ - "author", - "editor", - "reviewer", - "endorser" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "The name of the individual or organization responsible for the contribution.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the contributor.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "DataRequirement": { - "description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "The profile of the required data, specified as the uri of the profile definition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "subjectCodeableConcept": { - "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", - "$ref": "#/definitions/Reference" - }, - "mustSupport": { - "description": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. \n\nThe value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_mustSupport": { - "description": "Extensions for mustSupport", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "codeFilter": { - "description": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND\u0027ed, not OR\u0027ed.", - "items": { - "$ref": "#/definitions/DataRequirement_CodeFilter" - }, - "type": "array" - }, - "dateFilter": { - "description": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND\u0027ed, not OR\u0027ed.", - "items": { - "$ref": "#/definitions/DataRequirement_DateFilter" - }, - "type": "array" - }, - "limit": { - "description": "Specifies a maximum number of results that are required (uses the _count search parameter).", - "$ref": "#/definitions/positiveInt" - }, - "_limit": { - "description": "Extensions for limit", - "$ref": "#/definitions/Element" - }, - "sort": { - "description": "Specifies the order of the results to be returned.", - "items": { - "$ref": "#/definitions/DataRequirement_Sort" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "DataRequirement_CodeFilter": { - "description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "searchParam": { - "description": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.", - "$ref": "#/definitions/string" - }, - "_searchParam": { - "description": "Extensions for searchParam", - "$ref": "#/definitions/Element" - }, - "valueSet": { - "description": "The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.", - "$ref": "#/definitions/canonical" - }, - "code": { - "description": "The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "DataRequirement_DateFilter": { - "description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "searchParam": { - "description": "A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.", - "$ref": "#/definitions/string" - }, - "_searchParam": { - "description": "Extensions for searchParam", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valuePeriod": { - "description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.", - "$ref": "#/definitions/Period" - }, - "valueDuration": { - "description": "The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "DataRequirement_Sort": { - "description": "Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "direction": { - "description": "The direction of the sort, ascending or descending.", - "enum": [ - "ascending", - "descending" - ] - }, - "_direction": { - "description": "Extensions for direction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ParameterDefinition": { - "description": "The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the parameter used to allow access to the value of the parameter in evaluation contexts.", - "$ref": "#/definitions/code" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "use": { - "description": "Whether the parameter is input or output for the module.", - "$ref": "#/definitions/code" - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "min": { - "description": "The minimum number of times this parameter SHALL appear in the request or response.", - "$ref": "#/definitions/integer" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "The maximum number of times this element is permitted to appear in the request or response.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "A brief discussion of what the parameter is for and how it is used by the module.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of the parameter.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false - }, - "RelatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of relationship to the related artifact.", - "enum": [ - "documentation", - "justification", - "citation", - "predecessor", - "successor", - "derived-from", - "depends-on", - "composed-of" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "label": { - "description": "A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.", - "$ref": "#/definitions/string" - }, - "_label": { - "description": "Extensions for label", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "citation": { - "description": "A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.", - "$ref": "#/definitions/markdown" - }, - "_citation": { - "description": "Extensions for citation", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "A url for the artifact that can be followed to access the actual content.", - "$ref": "#/definitions/url" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "document": { - "description": "The document being referenced, represented as an attachment. This is exclusive with the resource element.", - "$ref": "#/definitions/Attachment" - }, - "resource": { - "description": "The related resource, such as a library, value set, profile, or other knowledge resource.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false - }, - "TriggerDefinition": { - "description": "A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of triggering event.", - "enum": [ - "named-event", - "periodic", - "data-changed", - "data-added", - "data-modified", - "data-removed", - "data-accessed", - "data-access-ended" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "timingTiming": { - "description": "The timing of the event (if this is a periodic trigger).", - "$ref": "#/definitions/Timing" - }, - "timingReference": { - "description": "The timing of the event (if this is a periodic trigger).", - "$ref": "#/definitions/Reference" - }, - "timingDate": { - "description": "The timing of the event (if this is a periodic trigger).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_timingDate": { - "description": "Extensions for timingDate", - "$ref": "#/definitions/Element" - }, - "timingDateTime": { - "description": "The timing of the event (if this is a periodic trigger).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timingDateTime": { - "description": "Extensions for timingDateTime", - "$ref": "#/definitions/Element" - }, - "data": { - "description": "The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.", - "items": { - "$ref": "#/definitions/DataRequirement" - }, - "type": "array" - }, - "condition": { - "description": "A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false - }, - "UsageContext": { - "description": "Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code that identifies the type of context being specified by this usage context.", - "$ref": "#/definitions/Coding" - }, - "valueCodeableConcept": { - "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", - "$ref": "#/definitions/Range" - }, - "valueReference": { - "description": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "Dosage": { - "description": "Indicates how the medication is/was taken or should be taken by the patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "Indicates the order in which the dosage instructions should be applied or interpreted.", - "$ref": "#/definitions/integer" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "Free text dosage instructions e.g. SIG.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "additionalInstruction": { - "description": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "patientInstruction": { - "description": "Instructions in terms that are understood by the patient or consumer.", - "$ref": "#/definitions/string" - }, - "_patientInstruction": { - "description": "Extensions for patientInstruction", - "$ref": "#/definitions/Element" - }, - "timing": { - "description": "When medication should be administered.", - "$ref": "#/definitions/Timing" - }, - "asNeededBoolean": { - "description": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).", - "pattern": "^true|false$", - "type": "boolean" - }, - "_asNeededBoolean": { - "description": "Extensions for asNeededBoolean", - "$ref": "#/definitions/Element" - }, - "asNeededCodeableConcept": { - "description": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).", - "$ref": "#/definitions/CodeableConcept" - }, - "site": { - "description": "Body site to administer to.", - "$ref": "#/definitions/CodeableConcept" - }, - "route": { - "description": "How drug should enter body.", - "$ref": "#/definitions/CodeableConcept" - }, - "method": { - "description": "Technique for administering medication.", - "$ref": "#/definitions/CodeableConcept" - }, - "doseAndRate": { - "description": "The amount of medication administered.", - "items": { - "$ref": "#/definitions/Dosage_DoseAndRate" - }, - "type": "array" - }, - "maxDosePerPeriod": { - "description": "Upper limit on medication per unit of time.", - "$ref": "#/definitions/Ratio" - }, - "maxDosePerAdministration": { - "description": "Upper limit on medication per administration.", - "$ref": "#/definitions/Quantity" - }, - "maxDosePerLifetime": { - "description": "Upper limit on medication per lifetime of the patient.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Dosage_DoseAndRate": { - "description": "Indicates how the medication is/was taken or should be taken by the patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The kind of dose or rate specified, for example, ordered or calculated.", - "$ref": "#/definitions/CodeableConcept" - }, - "doseRange": { - "description": "Amount of medication per dose.", - "$ref": "#/definitions/Range" - }, - "doseQuantity": { - "description": "Amount of medication per dose.", - "$ref": "#/definitions/Quantity" - }, - "rateRatio": { - "description": "Amount of medication per unit of time.", - "$ref": "#/definitions/Ratio" - }, - "rateRange": { - "description": "Amount of medication per unit of time.", - "$ref": "#/definitions/Range" - }, - "rateQuantity": { - "description": "Amount of medication per unit of time.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Population": { - "description": "A populatioof people with some set of grouping criteria.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "ageRange": { - "description": "The age of the specific population.", - "$ref": "#/definitions/Range" - }, - "ageCodeableConcept": { - "description": "The age of the specific population.", - "$ref": "#/definitions/CodeableConcept" - }, - "gender": { - "description": "The gender of the specific population.", - "$ref": "#/definitions/CodeableConcept" - }, - "race": { - "description": "Race of the specific population.", - "$ref": "#/definitions/CodeableConcept" - }, - "physiologicalCondition": { - "description": "The existing physiological conditions of the specific population to which this applies.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ProductShelfLife": { - "description": "The shelf-life and storage information for a medicinal product item or container can be described using this class.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for the packaged Medicinal Product.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "period": { - "description": "The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "specialPrecautionsForStorage": { - "description": "Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "period", - "type" - ] - }, - "ProdCharacteristic": { - "description": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "height": { - "description": "Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "width": { - "description": "Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "depth": { - "description": "Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "weight": { - "description": "Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "nominalVolume": { - "description": "Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "externalDiameter": { - "description": "Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.", - "$ref": "#/definitions/Quantity" - }, - "shape": { - "description": "Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", - "$ref": "#/definitions/string" - }, - "_shape": { - "description": "Extensions for shape", - "$ref": "#/definitions/Element" - }, - "color": { - "description": "Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_color": { - "description": "Extensions for color", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "imprint": { - "description": "Where applicable, the imprint can be specified as text.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_imprint": { - "description": "Extensions for imprint", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "image": { - "description": "Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - }, - "scoring": { - "description": "Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "MarketingStatus": { - "description": "The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "country": { - "description": "The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.", - "$ref": "#/definitions/CodeableConcept" - }, - "jurisdiction": { - "description": "Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.", - "$ref": "#/definitions/CodeableConcept" - }, - "dateRange": { - "description": "The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.", - "$ref": "#/definitions/Period" - }, - "restoreDate": { - "description": "The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.", - "$ref": "#/definitions/dateTime" - }, - "_restoreDate": { - "description": "Extensions for restoreDate", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "country", - "dateRange", - "status" - ] - }, - "SubstanceAmount": { - "description": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "amountQuantity": { - "description": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.", - "$ref": "#/definitions/Quantity" - }, - "amountRange": { - "description": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.", - "$ref": "#/definitions/Range" - }, - "amountString": { - "description": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_amountString": { - "description": "Extensions for amountString", - "$ref": "#/definitions/Element" - }, - "amountType": { - "description": "Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.", - "$ref": "#/definitions/CodeableConcept" - }, - "amountText": { - "description": "A textual comment on a numeric value.", - "$ref": "#/definitions/string" - }, - "_amountText": { - "description": "Extensions for amountText", - "$ref": "#/definitions/Element" - }, - "referenceRange": { - "description": "Reference range of possible or expected values.", - "$ref": "#/definitions/SubstanceAmount_ReferenceRange" - } - }, - "additionalProperties": false - }, - "SubstanceAmount_ReferenceRange": { - "description": "Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "lowLimit": { - "description": "Lower limit possible or expected.", - "$ref": "#/definitions/Quantity" - }, - "highLimit": { - "description": "Upper limit possible or expected.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Expression": { - "description": "A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "A brief, natural language description of the condition that effectively communicates the intended semantics.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.", - "$ref": "#/definitions/id" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The media type of the language for the expression.", - "enum": [ - "text/cql", - "text/fhirpath", - "application/x-fhir-query" - ] - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression in the specified language that returns a value.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "reference": { - "description": "A URI that defines where the expression is found.", - "$ref": "#/definitions/uri" - }, - "_reference": { - "description": "Extensions for reference", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ElementDefinition": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource or extension.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "representation": { - "description": "Codes that define how this element is represented in instances, when the deviation varies from the normal case.", - "items": { - "enum": [ - "xmlAttr", - "xmlText", - "typeAttr", - "cdaText", - "xhtml" - ] - }, - "type": "array" - }, - "_representation": { - "description": "Extensions for representation", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "sliceName": { - "description": "The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.", - "$ref": "#/definitions/string" - }, - "_sliceName": { - "description": "Extensions for sliceName", - "$ref": "#/definitions/Element" - }, - "sliceIsConstraining": { - "description": "If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.", - "$ref": "#/definitions/boolean" - }, - "_sliceIsConstraining": { - "description": "Extensions for sliceIsConstraining", - "$ref": "#/definitions/Element" - }, - "label": { - "description": "A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.", - "$ref": "#/definitions/string" - }, - "_label": { - "description": "Extensions for label", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that has the same meaning as the element in a particular terminology.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "slicing": { - "description": "Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).", - "$ref": "#/definitions/ElementDefinition_Slicing" - }, - "short": { - "description": "A concise description of what this element means (e.g. for use in autogenerated summaries).", - "$ref": "#/definitions/string" - }, - "_short": { - "description": "Extensions for short", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).", - "$ref": "#/definitions/markdown" - }, - "_definition": { - "description": "Extensions for definition", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).", - "$ref": "#/definitions/markdown" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "requirements": { - "description": "This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.", - "$ref": "#/definitions/markdown" - }, - "_requirements": { - "description": "Extensions for requirements", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "Identifies additional names by which this element might also be known.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_alias": { - "description": "Extensions for alias", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "min": { - "description": "The minimum number of times this element SHALL appear in the instance.", - "$ref": "#/definitions/unsignedInt" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "The maximum number of times this element is permitted to appear in the instance.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - }, - "base": { - "description": "Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.", - "$ref": "#/definitions/ElementDefinition_Base" - }, - "contentReference": { - "description": "Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.", - "$ref": "#/definitions/uri" - }, - "_contentReference": { - "description": "Extensions for contentReference", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The data type or resource that the value of this element is permitted to be.", - "items": { - "$ref": "#/definitions/ElementDefinition_Type" - }, - "type": "array" - }, - "defaultValueBase64Binary": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_defaultValueBase64Binary": { - "description": "Extensions for defaultValueBase64Binary", - "$ref": "#/definitions/Element" - }, - "defaultValueBoolean": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^true|false$", - "type": "boolean" - }, - "_defaultValueBoolean": { - "description": "Extensions for defaultValueBoolean", - "$ref": "#/definitions/Element" - }, - "defaultValueCanonical": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueCanonical": { - "description": "Extensions for defaultValueCanonical", - "$ref": "#/definitions/Element" - }, - "defaultValueCode": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_defaultValueCode": { - "description": "Extensions for defaultValueCode", - "$ref": "#/definitions/Element" - }, - "defaultValueDate": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_defaultValueDate": { - "description": "Extensions for defaultValueDate", - "$ref": "#/definitions/Element" - }, - "defaultValueDateTime": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_defaultValueDateTime": { - "description": "Extensions for defaultValueDateTime", - "$ref": "#/definitions/Element" - }, - "defaultValueDecimal": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_defaultValueDecimal": { - "description": "Extensions for defaultValueDecimal", - "$ref": "#/definitions/Element" - }, - "defaultValueId": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_defaultValueId": { - "description": "Extensions for defaultValueId", - "$ref": "#/definitions/Element" - }, - "defaultValueInstant": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_defaultValueInstant": { - "description": "Extensions for defaultValueInstant", - "$ref": "#/definitions/Element" - }, - "defaultValueInteger": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_defaultValueInteger": { - "description": "Extensions for defaultValueInteger", - "$ref": "#/definitions/Element" - }, - "defaultValueMarkdown": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_defaultValueMarkdown": { - "description": "Extensions for defaultValueMarkdown", - "$ref": "#/definitions/Element" - }, - "defaultValueOid": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_defaultValueOid": { - "description": "Extensions for defaultValueOid", - "$ref": "#/definitions/Element" - }, - "defaultValuePositiveInt": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_defaultValuePositiveInt": { - "description": "Extensions for defaultValuePositiveInt", - "$ref": "#/definitions/Element" - }, - "defaultValueString": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_defaultValueString": { - "description": "Extensions for defaultValueString", - "$ref": "#/definitions/Element" - }, - "defaultValueTime": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_defaultValueTime": { - "description": "Extensions for defaultValueTime", - "$ref": "#/definitions/Element" - }, - "defaultValueUnsignedInt": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_defaultValueUnsignedInt": { - "description": "Extensions for defaultValueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "defaultValueUri": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueUri": { - "description": "Extensions for defaultValueUri", - "$ref": "#/definitions/Element" - }, - "defaultValueUrl": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueUrl": { - "description": "Extensions for defaultValueUrl", - "$ref": "#/definitions/Element" - }, - "defaultValueUuid": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_defaultValueUuid": { - "description": "Extensions for defaultValueUuid", - "$ref": "#/definitions/Element" - }, - "defaultValueAddress": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Address" - }, - "defaultValueAge": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Age" - }, - "defaultValueAnnotation": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Annotation" - }, - "defaultValueAttachment": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Attachment" - }, - "defaultValueCodeableConcept": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/CodeableConcept" - }, - "defaultValueCoding": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Coding" - }, - "defaultValueContactPoint": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/ContactPoint" - }, - "defaultValueCount": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Count" - }, - "defaultValueDistance": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Distance" - }, - "defaultValueDuration": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Duration" - }, - "defaultValueHumanName": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/HumanName" - }, - "defaultValueIdentifier": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Identifier" - }, - "defaultValueMoney": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Money" - }, - "defaultValuePeriod": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Period" - }, - "defaultValueQuantity": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Quantity" - }, - "defaultValueRange": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Range" - }, - "defaultValueRatio": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Ratio" - }, - "defaultValueReference": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Reference" - }, - "defaultValueSampledData": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/SampledData" - }, - "defaultValueSignature": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Signature" - }, - "defaultValueTiming": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Timing" - }, - "defaultValueContactDetail": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/ContactDetail" - }, - "defaultValueContributor": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Contributor" - }, - "defaultValueDataRequirement": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/DataRequirement" - }, - "defaultValueExpression": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Expression" - }, - "defaultValueParameterDefinition": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/ParameterDefinition" - }, - "defaultValueRelatedArtifact": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/RelatedArtifact" - }, - "defaultValueTriggerDefinition": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/TriggerDefinition" - }, - "defaultValueUsageContext": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/UsageContext" - }, - "defaultValueDosage": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Dosage" - }, - "defaultValueMeta": { - "description": "The value that should be used if there is no value stated in the instance (e.g. \u0027if not otherwise specified, the abstract is false\u0027).", - "$ref": "#/definitions/Meta" - }, - "meaningWhenMissing": { - "description": "The Implicit meaning that is to be understood when this element is missing (e.g. \u0027when this element is missing, the period is ongoing\u0027).", - "$ref": "#/definitions/markdown" - }, - "_meaningWhenMissing": { - "description": "Extensions for meaningWhenMissing", - "$ref": "#/definitions/Element" - }, - "orderMeaning": { - "description": "If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.", - "$ref": "#/definitions/string" - }, - "_orderMeaning": { - "description": "Extensions for orderMeaning", - "$ref": "#/definitions/Element" - }, - "fixedBase64Binary": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_fixedBase64Binary": { - "description": "Extensions for fixedBase64Binary", - "$ref": "#/definitions/Element" - }, - "fixedBoolean": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_fixedBoolean": { - "description": "Extensions for fixedBoolean", - "$ref": "#/definitions/Element" - }, - "fixedCanonical": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^\\S*$", - "type": "string" - }, - "_fixedCanonical": { - "description": "Extensions for fixedCanonical", - "$ref": "#/definitions/Element" - }, - "fixedCode": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_fixedCode": { - "description": "Extensions for fixedCode", - "$ref": "#/definitions/Element" - }, - "fixedDate": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_fixedDate": { - "description": "Extensions for fixedDate", - "$ref": "#/definitions/Element" - }, - "fixedDateTime": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_fixedDateTime": { - "description": "Extensions for fixedDateTime", - "$ref": "#/definitions/Element" - }, - "fixedDecimal": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_fixedDecimal": { - "description": "Extensions for fixedDecimal", - "$ref": "#/definitions/Element" - }, - "fixedId": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_fixedId": { - "description": "Extensions for fixedId", - "$ref": "#/definitions/Element" - }, - "fixedInstant": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_fixedInstant": { - "description": "Extensions for fixedInstant", - "$ref": "#/definitions/Element" - }, - "fixedInteger": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_fixedInteger": { - "description": "Extensions for fixedInteger", - "$ref": "#/definitions/Element" - }, - "fixedMarkdown": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_fixedMarkdown": { - "description": "Extensions for fixedMarkdown", - "$ref": "#/definitions/Element" - }, - "fixedOid": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_fixedOid": { - "description": "Extensions for fixedOid", - "$ref": "#/definitions/Element" - }, - "fixedPositiveInt": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_fixedPositiveInt": { - "description": "Extensions for fixedPositiveInt", - "$ref": "#/definitions/Element" - }, - "fixedString": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_fixedString": { - "description": "Extensions for fixedString", - "$ref": "#/definitions/Element" - }, - "fixedTime": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_fixedTime": { - "description": "Extensions for fixedTime", - "$ref": "#/definitions/Element" - }, - "fixedUnsignedInt": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_fixedUnsignedInt": { - "description": "Extensions for fixedUnsignedInt", - "$ref": "#/definitions/Element" - }, - "fixedUri": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^\\S*$", - "type": "string" - }, - "_fixedUri": { - "description": "Extensions for fixedUri", - "$ref": "#/definitions/Element" - }, - "fixedUrl": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^\\S*$", - "type": "string" - }, - "_fixedUrl": { - "description": "Extensions for fixedUrl", - "$ref": "#/definitions/Element" - }, - "fixedUuid": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_fixedUuid": { - "description": "Extensions for fixedUuid", - "$ref": "#/definitions/Element" - }, - "fixedAddress": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Address" - }, - "fixedAge": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Age" - }, - "fixedAnnotation": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Annotation" - }, - "fixedAttachment": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Attachment" - }, - "fixedCodeableConcept": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/CodeableConcept" - }, - "fixedCoding": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Coding" - }, - "fixedContactPoint": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/ContactPoint" - }, - "fixedCount": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Count" - }, - "fixedDistance": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Distance" - }, - "fixedDuration": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Duration" - }, - "fixedHumanName": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/HumanName" - }, - "fixedIdentifier": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Identifier" - }, - "fixedMoney": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Money" - }, - "fixedPeriod": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Period" - }, - "fixedQuantity": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Quantity" - }, - "fixedRange": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Range" - }, - "fixedRatio": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Ratio" - }, - "fixedReference": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Reference" - }, - "fixedSampledData": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/SampledData" - }, - "fixedSignature": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Signature" - }, - "fixedTiming": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Timing" - }, - "fixedContactDetail": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/ContactDetail" - }, - "fixedContributor": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Contributor" - }, - "fixedDataRequirement": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/DataRequirement" - }, - "fixedExpression": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Expression" - }, - "fixedParameterDefinition": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/ParameterDefinition" - }, - "fixedRelatedArtifact": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/RelatedArtifact" - }, - "fixedTriggerDefinition": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/TriggerDefinition" - }, - "fixedUsageContext": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/UsageContext" - }, - "fixedDosage": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Dosage" - }, - "fixedMeta": { - "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.", - "$ref": "#/definitions/Meta" - }, - "patternBase64Binary": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_patternBase64Binary": { - "description": "Extensions for patternBase64Binary", - "$ref": "#/definitions/Element" - }, - "patternBoolean": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_patternBoolean": { - "description": "Extensions for patternBoolean", - "$ref": "#/definitions/Element" - }, - "patternCanonical": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^\\S*$", - "type": "string" - }, - "_patternCanonical": { - "description": "Extensions for patternCanonical", - "$ref": "#/definitions/Element" - }, - "patternCode": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_patternCode": { - "description": "Extensions for patternCode", - "$ref": "#/definitions/Element" - }, - "patternDate": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_patternDate": { - "description": "Extensions for patternDate", - "$ref": "#/definitions/Element" - }, - "patternDateTime": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_patternDateTime": { - "description": "Extensions for patternDateTime", - "$ref": "#/definitions/Element" - }, - "patternDecimal": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_patternDecimal": { - "description": "Extensions for patternDecimal", - "$ref": "#/definitions/Element" - }, - "patternId": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_patternId": { - "description": "Extensions for patternId", - "$ref": "#/definitions/Element" - }, - "patternInstant": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_patternInstant": { - "description": "Extensions for patternInstant", - "$ref": "#/definitions/Element" - }, - "patternInteger": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_patternInteger": { - "description": "Extensions for patternInteger", - "$ref": "#/definitions/Element" - }, - "patternMarkdown": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_patternMarkdown": { - "description": "Extensions for patternMarkdown", - "$ref": "#/definitions/Element" - }, - "patternOid": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_patternOid": { - "description": "Extensions for patternOid", - "$ref": "#/definitions/Element" - }, - "patternPositiveInt": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_patternPositiveInt": { - "description": "Extensions for patternPositiveInt", - "$ref": "#/definitions/Element" - }, - "patternString": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_patternString": { - "description": "Extensions for patternString", - "$ref": "#/definitions/Element" - }, - "patternTime": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_patternTime": { - "description": "Extensions for patternTime", - "$ref": "#/definitions/Element" - }, - "patternUnsignedInt": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_patternUnsignedInt": { - "description": "Extensions for patternUnsignedInt", - "$ref": "#/definitions/Element" - }, - "patternUri": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^\\S*$", - "type": "string" - }, - "_patternUri": { - "description": "Extensions for patternUri", - "$ref": "#/definitions/Element" - }, - "patternUrl": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^\\S*$", - "type": "string" - }, - "_patternUrl": { - "description": "Extensions for patternUrl", - "$ref": "#/definitions/Element" - }, - "patternUuid": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_patternUuid": { - "description": "Extensions for patternUuid", - "$ref": "#/definitions/Element" - }, - "patternAddress": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Address" - }, - "patternAge": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Age" - }, - "patternAnnotation": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Annotation" - }, - "patternAttachment": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Attachment" - }, - "patternCodeableConcept": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/CodeableConcept" - }, - "patternCoding": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Coding" - }, - "patternContactPoint": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/ContactPoint" - }, - "patternCount": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Count" - }, - "patternDistance": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Distance" - }, - "patternDuration": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Duration" - }, - "patternHumanName": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/HumanName" - }, - "patternIdentifier": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Identifier" - }, - "patternMoney": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Money" - }, - "patternPeriod": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Period" - }, - "patternQuantity": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Quantity" - }, - "patternRange": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Range" - }, - "patternRatio": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Ratio" - }, - "patternReference": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Reference" - }, - "patternSampledData": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/SampledData" - }, - "patternSignature": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Signature" - }, - "patternTiming": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Timing" - }, - "patternContactDetail": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/ContactDetail" - }, - "patternContributor": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Contributor" - }, - "patternDataRequirement": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/DataRequirement" - }, - "patternExpression": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Expression" - }, - "patternParameterDefinition": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/ParameterDefinition" - }, - "patternRelatedArtifact": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/RelatedArtifact" - }, - "patternTriggerDefinition": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/TriggerDefinition" - }, - "patternUsageContext": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/UsageContext" - }, - "patternDosage": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Dosage" - }, - "patternMeta": { - "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value.", - "$ref": "#/definitions/Meta" - }, - "example": { - "description": "A sample value for this element demonstrating the type of information that would typically be found in the element.", - "items": { - "$ref": "#/definitions/ElementDefinition_Example" - }, - "type": "array" - }, - "minValueDate": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_minValueDate": { - "description": "Extensions for minValueDate", - "$ref": "#/definitions/Element" - }, - "minValueDateTime": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_minValueDateTime": { - "description": "Extensions for minValueDateTime", - "$ref": "#/definitions/Element" - }, - "minValueInstant": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_minValueInstant": { - "description": "Extensions for minValueInstant", - "$ref": "#/definitions/Element" - }, - "minValueTime": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_minValueTime": { - "description": "Extensions for minValueTime", - "$ref": "#/definitions/Element" - }, - "minValueDecimal": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_minValueDecimal": { - "description": "Extensions for minValueDecimal", - "$ref": "#/definitions/Element" - }, - "minValueInteger": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_minValueInteger": { - "description": "Extensions for minValueInteger", - "$ref": "#/definitions/Element" - }, - "minValuePositiveInt": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_minValuePositiveInt": { - "description": "Extensions for minValuePositiveInt", - "$ref": "#/definitions/Element" - }, - "minValueUnsignedInt": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_minValueUnsignedInt": { - "description": "Extensions for minValueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "minValueQuantity": { - "description": "The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "$ref": "#/definitions/Quantity" - }, - "maxValueDate": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_maxValueDate": { - "description": "Extensions for maxValueDate", - "$ref": "#/definitions/Element" - }, - "maxValueDateTime": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_maxValueDateTime": { - "description": "Extensions for maxValueDateTime", - "$ref": "#/definitions/Element" - }, - "maxValueInstant": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_maxValueInstant": { - "description": "Extensions for maxValueInstant", - "$ref": "#/definitions/Element" - }, - "maxValueTime": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_maxValueTime": { - "description": "Extensions for maxValueTime", - "$ref": "#/definitions/Element" - }, - "maxValueDecimal": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_maxValueDecimal": { - "description": "Extensions for maxValueDecimal", - "$ref": "#/definitions/Element" - }, - "maxValueInteger": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_maxValueInteger": { - "description": "Extensions for maxValueInteger", - "$ref": "#/definitions/Element" - }, - "maxValuePositiveInt": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_maxValuePositiveInt": { - "description": "Extensions for maxValuePositiveInt", - "$ref": "#/definitions/Element" - }, - "maxValueUnsignedInt": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_maxValueUnsignedInt": { - "description": "Extensions for maxValueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "maxValueQuantity": { - "description": "The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.", - "$ref": "#/definitions/Quantity" - }, - "maxLength": { - "description": "Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.", - "$ref": "#/definitions/integer" - }, - "_maxLength": { - "description": "Extensions for maxLength", - "$ref": "#/definitions/Element" - }, - "condition": { - "description": "A reference to an invariant that may make additional statements about the cardinality or value in the instance.", - "items": { - "$ref": "#/definitions/id" - }, - "type": "array" - }, - "_condition": { - "description": "Extensions for condition", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "constraint": { - "description": "Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.", - "items": { - "$ref": "#/definitions/ElementDefinition_Constraint" - }, - "type": "array" - }, - "mustSupport": { - "description": "If true, implementations that produce or consume resources SHALL provide \"support\" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.", - "$ref": "#/definitions/boolean" - }, - "_mustSupport": { - "description": "Extensions for mustSupport", - "$ref": "#/definitions/Element" - }, - "isModifier": { - "description": "If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.", - "$ref": "#/definitions/boolean" - }, - "_isModifier": { - "description": "Extensions for isModifier", - "$ref": "#/definitions/Element" - }, - "isModifierReason": { - "description": "Explains how that element affects the interpretation of the resource or element that contains it.", - "$ref": "#/definitions/string" - }, - "_isModifierReason": { - "description": "Extensions for isModifierReason", - "$ref": "#/definitions/Element" - }, - "isSummary": { - "description": "Whether the element should be included if a client requests a search with the parameter _summary\u003dtrue.", - "$ref": "#/definitions/boolean" - }, - "_isSummary": { - "description": "Extensions for isSummary", - "$ref": "#/definitions/Element" - }, - "binding": { - "description": "Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).", - "$ref": "#/definitions/ElementDefinition_Binding" - }, - "mapping": { - "description": "Identifies a concept from an external specification that roughly corresponds to this element.", - "items": { - "$ref": "#/definitions/ElementDefinition_Mapping" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Slicing": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "discriminator": { - "description": "Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.", - "items": { - "$ref": "#/definitions/ElementDefinition_Discriminator" - }, - "type": "array" - }, - "description": { - "description": "A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "ordered": { - "description": "If the matching elements have to occur in the same order as defined in the profile.", - "$ref": "#/definitions/boolean" - }, - "_ordered": { - "description": "Extensions for ordered", - "$ref": "#/definitions/Element" - }, - "rules": { - "description": "Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.", - "enum": [ - "closed", - "open", - "openAtEnd" - ] - }, - "_rules": { - "description": "Extensions for rules", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Discriminator": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "How the element value is interpreted when discrimination is evaluated.", - "enum": [ - "value", - "exists", - "pattern", - "type", - "profile" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "path": { - "description": "A FHIRPath expression, using [the simple subset of FHIRPath](fhirpath.html#simple), that is used to identify the element on which discrimination is based.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Base": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "min": { - "description": "Minimum cardinality of the base element identified by the path.", - "$ref": "#/definitions/unsignedInt" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "Maximum cardinality of the base element identified by the path.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Type": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.", - "$ref": "#/definitions/uri" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "targetProfile": { - "description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "aggregation": { - "description": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.", - "items": { - "enum": [ - "contained", - "referenced", - "bundled" - ] - }, - "type": "array" - }, - "_aggregation": { - "description": "Extensions for aggregation", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "versioning": { - "description": "Whether this reference needs to be version specific or version independent, or whether either can be used.", - "enum": [ - "either", - "independent", - "specific" - ] - }, - "_versioning": { - "description": "Extensions for versioning", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Example": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "label": { - "description": "Describes the purpose of this example amoung the set of examples.", - "$ref": "#/definitions/string" - }, - "_label": { - "description": "Extensions for label", - "$ref": "#/definitions/Element" - }, - "valueBase64Binary": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueCanonical": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueCanonical": { - "description": "Extensions for valueCanonical", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueId": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueInstant": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_valueInstant": { - "description": "Extensions for valueInstant", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueMarkdown": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueMarkdown": { - "description": "Extensions for valueMarkdown", - "$ref": "#/definitions/Element" - }, - "valueOid": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_valueOid": { - "description": "Extensions for valueOid", - "$ref": "#/definitions/Element" - }, - "valuePositiveInt": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_valuePositiveInt": { - "description": "Extensions for valuePositiveInt", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueUnsignedInt": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_valueUnsignedInt": { - "description": "Extensions for valueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueUrl": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUrl": { - "description": "Extensions for valueUrl", - "$ref": "#/definitions/Element" - }, - "valueUuid": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_valueUuid": { - "description": "Extensions for valueUuid", - "$ref": "#/definitions/Element" - }, - "valueAddress": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Address" - }, - "valueAge": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Age" - }, - "valueAnnotation": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Annotation" - }, - "valueAttachment": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Attachment" - }, - "valueCodeableConcept": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCoding": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Coding" - }, - "valueContactPoint": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/ContactPoint" - }, - "valueCount": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Count" - }, - "valueDistance": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Distance" - }, - "valueDuration": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Duration" - }, - "valueHumanName": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/HumanName" - }, - "valueIdentifier": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Identifier" - }, - "valueMoney": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Money" - }, - "valuePeriod": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Period" - }, - "valueQuantity": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Ratio" - }, - "valueReference": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Reference" - }, - "valueSampledData": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/SampledData" - }, - "valueSignature": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Signature" - }, - "valueTiming": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Timing" - }, - "valueContactDetail": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/ContactDetail" - }, - "valueContributor": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Contributor" - }, - "valueDataRequirement": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/DataRequirement" - }, - "valueExpression": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Expression" - }, - "valueParameterDefinition": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/ParameterDefinition" - }, - "valueRelatedArtifact": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/RelatedArtifact" - }, - "valueTriggerDefinition": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/TriggerDefinition" - }, - "valueUsageContext": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/UsageContext" - }, - "valueDosage": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Dosage" - }, - "valueMeta": { - "description": "The actual value for the element, which must be one of the types allowed for this element.", - "$ref": "#/definitions/Meta" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Constraint": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "key": { - "description": "Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.", - "$ref": "#/definitions/id" - }, - "_key": { - "description": "Extensions for key", - "$ref": "#/definitions/Element" - }, - "requirements": { - "description": "Description of why this constraint is necessary or appropriate.", - "$ref": "#/definitions/string" - }, - "_requirements": { - "description": "Extensions for requirements", - "$ref": "#/definitions/Element" - }, - "severity": { - "description": "Identifies the impact constraint violation has on the conformance of the instance.", - "enum": [ - "error", - "warning" - ] - }, - "_severity": { - "description": "Extensions for severity", - "$ref": "#/definitions/Element" - }, - "human": { - "description": "Text that can be used to describe the constraint in messages identifying that the constraint has been violated.", - "$ref": "#/definitions/string" - }, - "_human": { - "description": "Extensions for human", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "xpath": { - "description": "An XPath expression of constraint that can be executed to see if this constraint is met.", - "$ref": "#/definitions/string" - }, - "_xpath": { - "description": "Extensions for xpath", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "A reference to the original source of the constraint, for traceability purposes.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Binding": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "strength": { - "description": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.", - "enum": [ - "required", - "extensible", - "preferred", - "example" - ] - }, - "_strength": { - "description": "Extensions for strength", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Describes the intended use of this particular set of codes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "valueSet": { - "description": "Refers to the value set that identifies the set of codes the binding refers to.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false - }, - "ElementDefinition_Mapping": { - "description": "Captures constraints on each element within the resource, profile, or extension.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identity": { - "description": "An internal reference to the definition of a mapping.", - "$ref": "#/definitions/id" - }, - "_identity": { - "description": "Extensions for identity", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "Identifies the computable language in which mapping.map is expressed.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "map": { - "description": "Expresses what part of the target specification corresponds to this element.", - "$ref": "#/definitions/string" - }, - "_map": { - "description": "Extensions for map", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Comments that provide information about the mapping or its use.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Account": { - "description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.", - "properties": { - "resourceType": { - "description": "This is a Account resource", - "const": "Account" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates whether the account is presently used/usable or not.", - "enum": [ - "active", - "inactive", - "entered-in-error", - "on-hold", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Categorizes the account for reporting and searching purposes.", - "$ref": "#/definitions/CodeableConcept" - }, - "name": { - "description": "Name used for the account when displaying it to humans in reports, etc.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "servicePeriod": { - "description": "The date range of services associated with this account.", - "$ref": "#/definitions/Period" - }, - "coverage": { - "description": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.", - "items": { - "$ref": "#/definitions/Account_Coverage" - }, - "type": "array" - }, - "owner": { - "description": "Indicates the service area, hospital, department, etc. with responsibility for managing the Account.", - "$ref": "#/definitions/Reference" - }, - "description": { - "description": "Provides additional information about what the account tracks and how it is used.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "guarantor": { - "description": "The parties responsible for balancing the account if other payment options fall short.", - "items": { - "$ref": "#/definitions/Account_Guarantor" - }, - "type": "array" - }, - "partOf": { - "description": "Reference to a parent Account.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Account_Coverage": { - "description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "coverage": { - "description": "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.", - "$ref": "#/definitions/Reference" - }, - "priority": { - "description": "The priority of the coverage in the context of this account.", - "$ref": "#/definitions/positiveInt" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "Account_Guarantor": { - "description": "A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "party": { - "description": "The entity who is responsible.", - "$ref": "#/definitions/Reference" - }, - "onHold": { - "description": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.", - "$ref": "#/definitions/boolean" - }, - "_onHold": { - "description": "Extensions for onHold", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The timeframe during which the guarantor accepts responsibility for the account.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "party" - ] - }, - "ActivityDefinition": { - "description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.", - "properties": { - "resourceType": { - "description": "This is a ActivityDefinition resource", - "const": "ActivityDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the activity definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the activity definition giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this activity definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "A code or group definition that describes the intended subject of the activity being defined.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "A code or group definition that describes the intended subject of the activity being defined.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the activity definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the activity definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the activity definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this activity definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description of how the activity definition is used from a clinical perspective.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the activity definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "library": { - "description": "A reference to a Library resource containing any formal logic used by the activity definition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "kind": { - "description": "A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.", - "$ref": "#/definitions/code" - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A profile to which the target of the activity definition is expected to conform.", - "$ref": "#/definitions/canonical" - }, - "code": { - "description": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.", - "$ref": "#/definitions/CodeableConcept" - }, - "intent": { - "description": "Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the activity should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "doNotPerform": { - "description": "Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "timingTiming": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Timing" - }, - "timingDateTime": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timingDateTime": { - "description": "Extensions for timingDateTime", - "$ref": "#/definitions/Element" - }, - "timingAge": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Age" - }, - "timingPeriod": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Period" - }, - "timingRange": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Range" - }, - "timingDuration": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Duration" - }, - "location": { - "description": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.", - "$ref": "#/definitions/Reference" - }, - "participant": { - "description": "Indicates who should participate in performing the action described.", - "items": { - "$ref": "#/definitions/ActivityDefinition_Participant" - }, - "type": "array" - }, - "productReference": { - "description": "Identifies the food, drug or other product being consumed or supplied in the activity.", - "$ref": "#/definitions/Reference" - }, - "productCodeableConcept": { - "description": "Identifies the food, drug or other product being consumed or supplied in the activity.", - "$ref": "#/definitions/CodeableConcept" - }, - "quantity": { - "description": "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).", - "$ref": "#/definitions/Quantity" - }, - "dosage": { - "description": "Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.", - "items": { - "$ref": "#/definitions/Dosage" - }, - "type": "array" - }, - "bodySite": { - "description": "Indicates the sites on the subject\u0027s body where the procedure should be performed (I.e. the target sites).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specimenRequirement": { - "description": "Defines specimen requirements for the action to be performed, such as required specimens for a lab test.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "observationRequirement": { - "description": "Defines observation requirements for the action to be performed, such as body weight or surface area.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "observationResultRequirement": { - "description": "Defines the observations that are expected to be produced by the action.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "transform": { - "description": "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.", - "$ref": "#/definitions/canonical" - }, - "dynamicValue": { - "description": "Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient\u0027s weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.", - "items": { - "$ref": "#/definitions/ActivityDefinition_DynamicValue" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ActivityDefinition_Participant": { - "description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of participant in the action.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "role": { - "description": "The role the participant should play in performing the described action.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ActivityDefinition_DynamicValue": { - "description": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression specifying the value of the customized element.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false, - "required": [ - "expression" - ] - }, - "AdverseEvent": { - "description": "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.", - "properties": { - "resourceType": { - "description": "This is a AdverseEvent resource", - "const": "AdverseEvent" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "$ref": "#/definitions/Identifier" - }, - "actuality": { - "description": "Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.", - "enum": [ - "actual", - "potential" - ] - }, - "_actuality": { - "description": "Extensions for actuality", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "The overall type of event, intended for search and filtering purposes.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "event": { - "description": "This element defines the specific type of event that occurred or that was prevented from occurring.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "This subject or group impacted by the event.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and perhaps time) when the adverse event occurred.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "detected": { - "description": "Estimated or actual date the AdverseEvent began, in the opinion of the reporter.", - "$ref": "#/definitions/dateTime" - }, - "_detected": { - "description": "Extensions for detected", - "$ref": "#/definitions/Element" - }, - "recordedDate": { - "description": "The date on which the existence of the AdverseEvent was first recorded.", - "$ref": "#/definitions/dateTime" - }, - "_recordedDate": { - "description": "Extensions for recordedDate", - "$ref": "#/definitions/Element" - }, - "resultingCondition": { - "description": "Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "location": { - "description": "The information about where the adverse event occurred.", - "$ref": "#/definitions/Reference" - }, - "seriousness": { - "description": "Assessment whether this event was of real importance.", - "$ref": "#/definitions/CodeableConcept" - }, - "severity": { - "description": "Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.", - "$ref": "#/definitions/CodeableConcept" - }, - "outcome": { - "description": "Describes the type of outcome from the adverse event.", - "$ref": "#/definitions/CodeableConcept" - }, - "recorder": { - "description": "Information on who recorded the adverse event. May be the patient or a practitioner.", - "$ref": "#/definitions/Reference" - }, - "contributor": { - "description": "Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "suspectEntity": { - "description": "Describes the entity that is suspected to have caused the adverse event.", - "items": { - "$ref": "#/definitions/AdverseEvent_SuspectEntity" - }, - "type": "array" - }, - "subjectMedicalHistory": { - "description": "AdverseEvent.subjectMedicalHistory.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "referenceDocument": { - "description": "AdverseEvent.referenceDocument.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "study": { - "description": "AdverseEvent.study.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "AdverseEvent_SuspectEntity": { - "description": "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "instance": { - "description": "Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.", - "$ref": "#/definitions/Reference" - }, - "causality": { - "description": "Information on the possible cause of the event.", - "items": { - "$ref": "#/definitions/AdverseEvent_Causality" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "instance" - ] - }, - "AdverseEvent_Causality": { - "description": "Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "assessment": { - "description": "Assessment of if the entity caused the event.", - "$ref": "#/definitions/CodeableConcept" - }, - "productRelatedness": { - "description": "AdverseEvent.suspectEntity.causalityProductRelatedness.", - "$ref": "#/definitions/string" - }, - "_productRelatedness": { - "description": "Extensions for productRelatedness", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "AdverseEvent.suspectEntity.causalityAuthor.", - "$ref": "#/definitions/Reference" - }, - "method": { - "description": "ProbabilityScale | Bayesian | Checklist.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "AllergyIntolerance": { - "description": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.", - "properties": { - "resourceType": { - "description": "This is a AllergyIntolerance resource", - "const": "AllergyIntolerance" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "clinicalStatus": { - "description": "The clinical status of the allergy or intolerance.", - "$ref": "#/definitions/CodeableConcept" - }, - "verificationStatus": { - "description": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "Identification of the underlying physiological mechanism for the reaction risk.", - "enum": [ - "allergy", - "intolerance" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Category of the identified substance.", - "items": { - "enum": [ - "food", - "medication", - "environment", - "biologic" - ] - }, - "type": "array" - }, - "_category": { - "description": "Extensions for category", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "criticality": { - "description": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.", - "enum": [ - "low", - "high", - "unable-to-assess" - ] - }, - "_criticality": { - "description": "Extensions for criticality", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., \"Latex\"), an allergy or intolerance condition (e.g., \"Latex allergy\"), or a negated/excluded code for a specific substance or class (e.g., \"No latex allergy\") or a general or categorical negated statement (e.g., \"No known allergy\", \"No known drug allergies\"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the \u0027code\u0027 and ignore the \u0027reaction.substance\u0027. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "patient": { - "description": "The patient who has the allergy or intolerance.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The encounter when the allergy or intolerance was asserted.", - "$ref": "#/definitions/Reference" - }, - "onsetDateTime": { - "description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_onsetDateTime": { - "description": "Extensions for onsetDateTime", - "$ref": "#/definitions/Element" - }, - "onsetAge": { - "description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", - "$ref": "#/definitions/Age" - }, - "onsetPeriod": { - "description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", - "$ref": "#/definitions/Period" - }, - "onsetRange": { - "description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", - "$ref": "#/definitions/Range" - }, - "onsetString": { - "description": "Estimated or actual date, date-time, or age when allergy or intolerance was identified.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_onsetString": { - "description": "Extensions for onsetString", - "$ref": "#/definitions/Element" - }, - "recordedDate": { - "description": "The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.", - "$ref": "#/definitions/dateTime" - }, - "_recordedDate": { - "description": "Extensions for recordedDate", - "$ref": "#/definitions/Element" - }, - "recorder": { - "description": "Individual who recorded the record and takes responsibility for its content.", - "$ref": "#/definitions/Reference" - }, - "asserter": { - "description": "The source of the information about the allergy that is recorded.", - "$ref": "#/definitions/Reference" - }, - "lastOccurrence": { - "description": "Represents the date and/or time of the last known occurrence of a reaction event.", - "$ref": "#/definitions/dateTime" - }, - "_lastOccurrence": { - "description": "Extensions for lastOccurrence", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "reaction": { - "description": "Details about each adverse reaction event linked to exposure to the identified substance.", - "items": { - "$ref": "#/definitions/AllergyIntolerance_Reaction" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "resourceType" - ] - }, - "AllergyIntolerance_Reaction": { - "description": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "substance": { - "description": "Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the \u0027code\u0027 and ignore the \u0027reaction.substance\u0027. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "manifestation": { - "description": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "Text description about the reaction as a whole, including details of the manifestation if required.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "onset": { - "description": "Record of the date and/or time of the onset of the Reaction.", - "$ref": "#/definitions/dateTime" - }, - "_onset": { - "description": "Extensions for onset", - "$ref": "#/definitions/Element" - }, - "severity": { - "description": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.", - "enum": [ - "mild", - "moderate", - "severe" - ] - }, - "_severity": { - "description": "Extensions for severity", - "$ref": "#/definitions/Element" - }, - "exposureRoute": { - "description": "Identification of the route by which the subject was exposed to the substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "note": { - "description": "Additional text about the adverse reaction event not captured in other fields.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "manifestation" - ] - }, - "Appointment": { - "description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).", - "properties": { - "resourceType": { - "description": "This is a Appointment resource", - "const": "Appointment" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.", - "enum": [ - "proposed", - "pending", - "booked", - "arrived", - "fulfilled", - "cancelled", - "noshow", - "entered-in-error", - "checked-in", - "waitlist" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "cancelationReason": { - "description": "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.", - "$ref": "#/definitions/CodeableConcept" - }, - "serviceCategory": { - "description": "A broad categorization of the service that is to be performed during this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "serviceType": { - "description": "The specific service that is to be performed during this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "appointmentType": { - "description": "The style of appointment or patient that has been booked in the slot (not service type).", - "$ref": "#/definitions/CodeableConcept" - }, - "reasonCode": { - "description": "The coded reason that this appointment is being scheduled. This is more clinical than administrative.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "priority": { - "description": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).", - "$ref": "#/definitions/unsignedInt" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "supportingInformation": { - "description": "Additional information to support the appointment provided when making the appointment.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "start": { - "description": "Date/Time that the appointment is to take place.", - "$ref": "#/definitions/instant" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "Date/Time that the appointment is to conclude.", - "$ref": "#/definitions/instant" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "minutesDuration": { - "description": "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.", - "$ref": "#/definitions/positiveInt" - }, - "_minutesDuration": { - "description": "Extensions for minutesDuration", - "$ref": "#/definitions/Element" - }, - "slot": { - "description": "The slots from the participants\u0027 schedules that will be filled by the appointment.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "created": { - "description": "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Additional comments about the appointment.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "patientInstruction": { - "description": "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).", - "$ref": "#/definitions/string" - }, - "_patientInstruction": { - "description": "Extensions for patientInstruction", - "$ref": "#/definitions/Element" - }, - "basedOn": { - "description": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "participant": { - "description": "List of participants involved in the appointment.", - "items": { - "$ref": "#/definitions/Appointment_Participant" - }, - "type": "array" - }, - "requestedPeriod": { - "description": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.", - "items": { - "$ref": "#/definitions/Period" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "participant", - "resourceType" - ] - }, - "Appointment_Participant": { - "description": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Role of participant in the appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "actor": { - "description": "A Person, Location/HealthcareService or Device that is participating in the appointment.", - "$ref": "#/definitions/Reference" - }, - "required": { - "description": "Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.", - "enum": [ - "required", - "optional", - "information-only" - ] - }, - "_required": { - "description": "Extensions for required", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "Participation status of the actor.", - "enum": [ - "accepted", - "declined", - "tentative", - "needs-action" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Participation period of the actor.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "AppointmentResponse": { - "description": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.", - "properties": { - "resourceType": { - "description": "This is a AppointmentResponse resource", - "const": "AppointmentResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "appointment": { - "description": "Appointment that this response is replying to.", - "$ref": "#/definitions/Reference" - }, - "start": { - "description": "Date/Time that the appointment is to take place, or requested new start time.", - "$ref": "#/definitions/instant" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.", - "$ref": "#/definitions/instant" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "participantType": { - "description": "Role of participant in the appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "actor": { - "description": "A Person, Location, HealthcareService, or Device that is participating in the appointment.", - "$ref": "#/definitions/Reference" - }, - "participantStatus": { - "description": "Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.", - "$ref": "#/definitions/code" - }, - "_participantStatus": { - "description": "Extensions for participantStatus", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Additional comments about the appointment.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "appointment", - "resourceType" - ] - }, - "AuditEvent": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "resourceType": { - "description": "This is a AuditEvent resource", - "const": "AuditEvent" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.", - "$ref": "#/definitions/Coding" - }, - "subtype": { - "description": "Identifier for the category of event.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "action": { - "description": "Indicator for type of action performed during the event that generated the audit.", - "enum": [ - "C", - "R", - "U", - "D", - "E" - ] - }, - "_action": { - "description": "Extensions for action", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period during which the activity occurred.", - "$ref": "#/definitions/Period" - }, - "recorded": { - "description": "The time when the event was recorded.", - "$ref": "#/definitions/instant" - }, - "_recorded": { - "description": "Extensions for recorded", - "$ref": "#/definitions/Element" - }, - "outcome": { - "description": "Indicates whether the event succeeded or failed.", - "enum": [ - "0", - "4", - "8", - "12" - ] - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "outcomeDesc": { - "description": "A free text description of the outcome of the event.", - "$ref": "#/definitions/string" - }, - "_outcomeDesc": { - "description": "Extensions for outcomeDesc", - "$ref": "#/definitions/Element" - }, - "purposeOfEvent": { - "description": "The purposeOfUse (reason) that was used during the event being recorded.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "agent": { - "description": "An actor taking an active role in the event or activity that is logged.", - "items": { - "$ref": "#/definitions/AuditEvent_Agent" - }, - "type": "array" - }, - "source": { - "description": "The system that is reporting the event.", - "$ref": "#/definitions/AuditEvent_Source" - }, - "entity": { - "description": "Specific instances of data or objects that have been accessed.", - "items": { - "$ref": "#/definitions/AuditEvent_Entity" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "agent", - "source", - "type", - "resourceType" - ] - }, - "AuditEvent_Agent": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Specification of the participation type the user plays when performing the event.", - "$ref": "#/definitions/CodeableConcept" - }, - "role": { - "description": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "who": { - "description": "Reference to who this agent is that was involved in the event.", - "$ref": "#/definitions/Reference" - }, - "altId": { - "description": "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.", - "$ref": "#/definitions/string" - }, - "_altId": { - "description": "Extensions for altId", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "Human-meaningful name for the agent.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "requestor": { - "description": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.", - "$ref": "#/definitions/boolean" - }, - "_requestor": { - "description": "Extensions for requestor", - "$ref": "#/definitions/Element" - }, - "location": { - "description": "Where the event occurred.", - "$ref": "#/definitions/Reference" - }, - "policy": { - "description": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_policy": { - "description": "Extensions for policy", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "media": { - "description": "Type of media involved. Used when the event is about exporting/importing onto media.", - "$ref": "#/definitions/Coding" - }, - "network": { - "description": "Logical network location for application activity, if the activity has a network location.", - "$ref": "#/definitions/AuditEvent_Network" - }, - "purposeOfUse": { - "description": "The reason (purpose of use), specific to this agent, that was used during the event being recorded.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "AuditEvent_Network": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "address": { - "description": "An identifier for the network access point of the user device for the audit event.", - "$ref": "#/definitions/string" - }, - "_address": { - "description": "Extensions for address", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "An identifier for the type of network access point that originated the audit event.", - "enum": [ - "1", - "2", - "3", - "4", - "5" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "AuditEvent_Source": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "site": { - "description": "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.", - "$ref": "#/definitions/string" - }, - "_site": { - "description": "Extensions for site", - "$ref": "#/definitions/Element" - }, - "observer": { - "description": "Identifier of the source where the event was detected.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "Code specifying the type of source where event originated.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "observer" - ] - }, - "AuditEvent_Entity": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "what": { - "description": "Identifies a specific instance of the entity. The reference should be version specific.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "The type of the object that was involved in this audit event.", - "$ref": "#/definitions/Coding" - }, - "role": { - "description": "Code representing the role the entity played in the event being audited.", - "$ref": "#/definitions/Coding" - }, - "lifecycle": { - "description": "Identifier for the data life-cycle stage for the entity.", - "$ref": "#/definitions/Coding" - }, - "securityLabel": { - "description": "Security labels for the identified entity.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "name": { - "description": "A name of the entity in the audit event.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Text that describes the entity in more detail.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "query": { - "description": "The query parameters for a query-type entities.", - "$ref": "#/definitions/base64Binary" - }, - "_query": { - "description": "Extensions for query", - "$ref": "#/definitions/Element" - }, - "detail": { - "description": "Tagged value pairs for conveying additional information about the entity.", - "items": { - "$ref": "#/definitions/AuditEvent_Detail" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "AuditEvent_Detail": { - "description": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of extra detail provided in the value.", - "$ref": "#/definitions/string" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The value of the extra detail.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueBase64Binary": { - "description": "The value of the extra detail.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Basic": { - "description": "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don\u0027t map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.", - "properties": { - "resourceType": { - "description": "This is a Basic resource", - "const": "Basic" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier assigned to the resource for business purposes, outside the context of FHIR.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "code": { - "description": "Identifies the \u0027type\u0027 of resource - equivalent to the resource name for other resources.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.", - "$ref": "#/definitions/Reference" - }, - "created": { - "description": "Identifies when the resource was first created.", - "$ref": "#/definitions/date" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Indicates who was responsible for creating the resource instance.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "code", - "resourceType" - ] - }, - "Binary": { - "description": "A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.", - "properties": { - "resourceType": { - "description": "This is a Binary resource", - "const": "Binary" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "contentType": { - "description": "MimeType of the binary content represented as a standard MimeType (BCP 13).", - "$ref": "#/definitions/code" - }, - "_contentType": { - "description": "Extensions for contentType", - "$ref": "#/definitions/Element" - }, - "securityContext": { - "description": "This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.", - "$ref": "#/definitions/Reference" - }, - "data": { - "description": "The actual content, base64 encoded.", - "$ref": "#/definitions/base64Binary" - }, - "_data": { - "description": "Extensions for data", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "BiologicallyDerivedProduct": { - "description": "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.", - "properties": { - "resourceType": { - "description": "This is a BiologicallyDerivedProduct resource", - "const": "BiologicallyDerivedProduct" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "productCategory": { - "description": "Broad category of this product.", - "enum": [ - "organ", - "tissue", - "fluid", - "cells", - "biologicalAgent" - ] - }, - "_productCategory": { - "description": "Extensions for productCategory", - "$ref": "#/definitions/Element" - }, - "productCode": { - "description": "A code that identifies the kind of this biologically derived product (SNOMED Ctcode).", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "Whether the product is currently available.", - "enum": [ - "available", - "unavailable" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "request": { - "description": "Procedure request to obtain this biologically derived product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "quantity": { - "description": "Number of discrete units within this product.", - "$ref": "#/definitions/integer" - }, - "_quantity": { - "description": "Extensions for quantity", - "$ref": "#/definitions/Element" - }, - "parent": { - "description": "Parent product (if any).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "collection": { - "description": "How this product was collected.", - "$ref": "#/definitions/BiologicallyDerivedProduct_Collection" - }, - "processing": { - "description": "Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.", - "items": { - "$ref": "#/definitions/BiologicallyDerivedProduct_Processing" - }, - "type": "array" - }, - "manipulation": { - "description": "Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.", - "$ref": "#/definitions/BiologicallyDerivedProduct_Manipulation" - }, - "storage": { - "description": "Product storage.", - "items": { - "$ref": "#/definitions/BiologicallyDerivedProduct_Storage" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "BiologicallyDerivedProduct_Collection": { - "description": "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "collector": { - "description": "Healthcare professional who is performing the collection.", - "$ref": "#/definitions/Reference" - }, - "source": { - "description": "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product.", - "$ref": "#/definitions/Reference" - }, - "collectedDateTime": { - "description": "Time of product collection.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_collectedDateTime": { - "description": "Extensions for collectedDateTime", - "$ref": "#/definitions/Element" - }, - "collectedPeriod": { - "description": "Time of product collection.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "BiologicallyDerivedProduct_Processing": { - "description": "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Description of of processing.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "procedure": { - "description": "Procesing code.", - "$ref": "#/definitions/CodeableConcept" - }, - "additive": { - "description": "Substance added during processing.", - "$ref": "#/definitions/Reference" - }, - "timeDateTime": { - "description": "Time of processing.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timeDateTime": { - "description": "Extensions for timeDateTime", - "$ref": "#/definitions/Element" - }, - "timePeriod": { - "description": "Time of processing.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "BiologicallyDerivedProduct_Manipulation": { - "description": "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Description of manipulation.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "timeDateTime": { - "description": "Time of manipulation.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timeDateTime": { - "description": "Extensions for timeDateTime", - "$ref": "#/definitions/Element" - }, - "timePeriod": { - "description": "Time of manipulation.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "BiologicallyDerivedProduct_Storage": { - "description": "A material substance originating from a biological entity intended to be transplanted or infused\ninto another (possibly the same) biological entity.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Description of storage.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "temperature": { - "description": "Storage temperature.", - "$ref": "#/definitions/decimal" - }, - "_temperature": { - "description": "Extensions for temperature", - "$ref": "#/definitions/Element" - }, - "scale": { - "description": "Temperature scale used.", - "enum": [ - "farenheit", - "celsius", - "kelvin" - ] - }, - "_scale": { - "description": "Extensions for scale", - "$ref": "#/definitions/Element" - }, - "duration": { - "description": "Storage timeperiod.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "BodyStructure": { - "description": "Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.", - "properties": { - "resourceType": { - "description": "This is a BodyStructure resource", - "const": "BodyStructure" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for this instance of the anatomical structure.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this body site is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "morphology": { - "description": "The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.", - "$ref": "#/definitions/CodeableConcept" - }, - "location": { - "description": "The anatomical location or region of the specimen, lesion, or body structure.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationQualifier": { - "description": "Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "A summary, characterization or explanation of the body structure.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "image": { - "description": "Image or images used to identify a location.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - }, - "patient": { - "description": "The person to which the body site belongs.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "resourceType" - ] - }, - "Bundle": { - "description": "A container for a collection of resources.", - "properties": { - "resourceType": { - "description": "This is a Bundle resource", - "const": "Bundle" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A persistent identifier for the bundle that won\u0027t change as a bundle is copied from server to server.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "Indicates the purpose of this bundle - how it is intended to be used.", - "enum": [ - "document", - "message", - "transaction", - "transaction-response", - "batch", - "batch-response", - "history", - "searchset", - "collection" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "timestamp": { - "description": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.", - "$ref": "#/definitions/instant" - }, - "_timestamp": { - "description": "Extensions for timestamp", - "$ref": "#/definitions/Element" - }, - "total": { - "description": "If a set of search matches, this is the total number of entries of type \u0027match\u0027 across all pages in the search. It does not include search.mode \u003d \u0027include\u0027 or \u0027outcome\u0027 entries and it does not provide a count of the number of entries in the Bundle.", - "$ref": "#/definitions/unsignedInt" - }, - "_total": { - "description": "Extensions for total", - "$ref": "#/definitions/Element" - }, - "link": { - "description": "A series of links that provide context to this bundle.", - "items": { - "$ref": "#/definitions/Bundle_Link" - }, - "type": "array" - }, - "entry": { - "description": "An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).", - "items": { - "$ref": "#/definitions/Bundle_Entry" - }, - "type": "array" - }, - "signature": { - "description": "Digital Signature - base64 encoded. XML-DSig or a JWT.", - "$ref": "#/definitions/Signature" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Bundle_Link": { - "description": "A container for a collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "relation": { - "description": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).", - "$ref": "#/definitions/string" - }, - "_relation": { - "description": "Extensions for relation", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "The reference details for the link.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Bundle_Entry": { - "description": "A container for a collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "link": { - "description": "A series of links that provide context to this entry.", - "items": { - "$ref": "#/definitions/Bundle_Link" - }, - "type": "array" - }, - "fullUrl": { - "description": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", - "$ref": "#/definitions/uri" - }, - "_fullUrl": { - "description": "Extensions for fullUrl", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", - "$ref": "#/definitions/ResourceList" - }, - "search": { - "description": "Information about the search process that lead to the creation of this entry.", - "$ref": "#/definitions/Bundle_Search" - }, - "request": { - "description": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", - "$ref": "#/definitions/Bundle_Request" - }, - "response": { - "description": "Indicates the results of processing the corresponding \u0027request\u0027 entry in the batch or transaction being responded to or what the results of an operation where when returning history.", - "$ref": "#/definitions/Bundle_Response" - } - }, - "additionalProperties": false - }, - "Bundle_Search": { - "description": "A container for a collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "Why this entry is in the result set - whether it\u0027s included as a match or because of an _include requirement, or to convey information or warning information about the search process.", - "enum": [ - "match", - "include", - "outcome" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "score": { - "description": "When searching, the server\u0027s search ranking score for the entry.", - "$ref": "#/definitions/decimal" - }, - "_score": { - "description": "Extensions for score", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Bundle_Request": { - "description": "A container for a collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "method": { - "description": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", - "enum": [ - "GET", - "HEAD", - "POST", - "PUT", - "DELETE", - "PATCH" - ] - }, - "_method": { - "description": "Extensions for method", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "The URL for this entry, relative to the root (the address to which the request is posted).", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "ifNoneMatch": { - "description": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", - "$ref": "#/definitions/string" - }, - "_ifNoneMatch": { - "description": "Extensions for ifNoneMatch", - "$ref": "#/definitions/Element" - }, - "ifModifiedSince": { - "description": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", - "$ref": "#/definitions/instant" - }, - "_ifModifiedSince": { - "description": "Extensions for ifModifiedSince", - "$ref": "#/definitions/Element" - }, - "ifMatch": { - "description": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", - "$ref": "#/definitions/string" - }, - "_ifMatch": { - "description": "Extensions for ifMatch", - "$ref": "#/definitions/Element" - }, - "ifNoneExist": { - "description": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", - "$ref": "#/definitions/string" - }, - "_ifNoneExist": { - "description": "Extensions for ifNoneExist", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Bundle_Response": { - "description": "A container for a collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "status": { - "description": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", - "$ref": "#/definitions/string" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "location": { - "description": "The location header created by processing this operation, populated if the operation returns a location.", - "$ref": "#/definitions/uri" - }, - "_location": { - "description": "Extensions for location", - "$ref": "#/definitions/Element" - }, - "etag": { - "description": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", - "$ref": "#/definitions/string" - }, - "_etag": { - "description": "Extensions for etag", - "$ref": "#/definitions/Element" - }, - "lastModified": { - "description": "The date/time that the resource was modified on the server.", - "$ref": "#/definitions/instant" - }, - "_lastModified": { - "description": "Extensions for lastModified", - "$ref": "#/definitions/Element" - }, - "outcome": { - "description": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", - "$ref": "#/definitions/ResourceList" - } - }, - "additionalProperties": false - }, - "CapabilityStatement": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "resourceType": { - "description": "This is a CapabilityStatement resource", - "const": "CapabilityStatement" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the capability statement.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this capability statement. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the capability statement.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the capability statement from a consumer\u0027s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the capability statement is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this capability statement is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "kind": { - "description": "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).", - "enum": [ - "instance", - "capability", - "requirements" - ] - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "instantiates": { - "description": "Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "imports": { - "description": "Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "software": { - "description": "Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.", - "$ref": "#/definitions/CapabilityStatement_Software" - }, - "implementation": { - "description": "Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.", - "$ref": "#/definitions/CapabilityStatement_Implementation" - }, - "fhirVersion": { - "description": "The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.", - "enum": [ - "0.01", - "0.05", - "0.06", - "0.11", - "0.0.80", - "0.0.81", - "0.0.82", - "0.4.0", - "0.5.0", - "1.0.0", - "1.0.1", - "1.0.2", - "1.1.0", - "1.4.0", - "1.6.0", - "1.8.0", - "3.0.0", - "3.0.1", - "3.3.0", - "3.5.0", - "4.0.0", - "4.0.1" - ] - }, - "_fhirVersion": { - "description": "Extensions for fhirVersion", - "$ref": "#/definitions/Element" - }, - "format": { - "description": "A list of the formats supported by this implementation using their content types.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_format": { - "description": "Extensions for format", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "patchFormat": { - "description": "A list of the patch formats supported by this implementation using their content types.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_patchFormat": { - "description": "Extensions for patchFormat", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "implementationGuide": { - "description": "A list of implementation guides that the server does (or should) support in their entirety.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "rest": { - "description": "A definition of the restful capabilities of the solution, if any.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Rest" - }, - "type": "array" - }, - "messaging": { - "description": "A description of the messaging capabilities of the solution.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Messaging" - }, - "type": "array" - }, - "document": { - "description": "A document definition.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Document" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "CapabilityStatement_Software": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name the software is known by.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version identifier for the software covered by this statement.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "releaseDate": { - "description": "Date this version of the software was released.", - "$ref": "#/definitions/dateTime" - }, - "_releaseDate": { - "description": "Extensions for releaseDate", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Implementation": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Information about the specific installation that this capability statement relates to.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.", - "$ref": "#/definitions/url" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "custodian": { - "description": "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Rest": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.", - "enum": [ - "client", - "server" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Information about the system\u0027s restful capabilities that apply across all applications, such as security.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "security": { - "description": "Information about security implementation from an interface perspective - what a client needs to know.", - "$ref": "#/definitions/CapabilityStatement_Security" - }, - "resource": { - "description": "A specification of the restful capabilities of the solution for a specific resource type.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Resource" - }, - "type": "array" - }, - "interaction": { - "description": "A specification of restful operations supported by the system.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Interaction1" - }, - "type": "array" - }, - "searchParam": { - "description": "Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.", - "items": { - "$ref": "#/definitions/CapabilityStatement_SearchParam" - }, - "type": "array" - }, - "operation": { - "description": "Definition of an operation or a named query together with its parameters and their meaning and type.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Operation" - }, - "type": "array" - }, - "compartment": { - "description": "An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Security": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "cors": { - "description": "Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.", - "$ref": "#/definitions/boolean" - }, - "_cors": { - "description": "Extensions for cors", - "$ref": "#/definitions/Element" - }, - "service": { - "description": "Types of security services that are supported/required by the system.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "General description of how security works.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Resource": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "A type of resource exposed via the restful interface.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A specification of the profile that describes the solution\u0027s overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).", - "$ref": "#/definitions/canonical" - }, - "supportedProfile": { - "description": "A list of profiles that represent different use cases supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "documentation": { - "description": "Additional information about the resource type used by the system.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "interaction": { - "description": "Identifies a restful operation supported by the solution.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Interaction" - }, - "type": "array" - }, - "versioning": { - "description": "This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is \u0027versioned-update\u0027, then the server supports all the versioning features, including using e-tags for version integrity in the API.", - "enum": [ - "no-version", - "versioned", - "versioned-update" - ] - }, - "_versioning": { - "description": "Extensions for versioning", - "$ref": "#/definitions/Element" - }, - "readHistory": { - "description": "A flag for whether the server is able to return past versions as part of the vRead operation.", - "$ref": "#/definitions/boolean" - }, - "_readHistory": { - "description": "Extensions for readHistory", - "$ref": "#/definitions/Element" - }, - "updateCreate": { - "description": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.", - "$ref": "#/definitions/boolean" - }, - "_updateCreate": { - "description": "Extensions for updateCreate", - "$ref": "#/definitions/Element" - }, - "conditionalCreate": { - "description": "A flag that indicates that the server supports conditional create.", - "$ref": "#/definitions/boolean" - }, - "_conditionalCreate": { - "description": "Extensions for conditionalCreate", - "$ref": "#/definitions/Element" - }, - "conditionalRead": { - "description": "A code that indicates how the server supports conditional read.", - "enum": [ - "not-supported", - "modified-since", - "not-match", - "full-support" - ] - }, - "_conditionalRead": { - "description": "Extensions for conditionalRead", - "$ref": "#/definitions/Element" - }, - "conditionalUpdate": { - "description": "A flag that indicates that the server supports conditional update.", - "$ref": "#/definitions/boolean" - }, - "_conditionalUpdate": { - "description": "Extensions for conditionalUpdate", - "$ref": "#/definitions/Element" - }, - "conditionalDelete": { - "description": "A code that indicates how the server supports conditional delete.", - "enum": [ - "not-supported", - "single", - "multiple" - ] - }, - "_conditionalDelete": { - "description": "Extensions for conditionalDelete", - "$ref": "#/definitions/Element" - }, - "referencePolicy": { - "description": "A set of flags that defines how references are supported.", - "items": { - "enum": [ - "literal", - "logical", - "resolves", - "enforced", - "local" - ] - }, - "type": "array" - }, - "_referencePolicy": { - "description": "Extensions for referencePolicy", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "searchInclude": { - "description": "A list of _include values supported by the server.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_searchInclude": { - "description": "Extensions for searchInclude", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "searchRevInclude": { - "description": "A list of _revinclude (reverse include) values supported by the server.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_searchRevInclude": { - "description": "Extensions for searchRevInclude", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "searchParam": { - "description": "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.", - "items": { - "$ref": "#/definitions/CapabilityStatement_SearchParam" - }, - "type": "array" - }, - "operation": { - "description": "Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Operation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Interaction": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Coded identifier of the operation, supported by the system resource.", - "enum": [ - "read", - "vread", - "update", - "patch", - "delete", - "history-instance", - "history-type", - "create", - "search-type" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Guidance specific to the implementation of this operation, such as \u0027delete is a logical delete\u0027 or \u0027updates are only allowed with version id\u0027 or \u0027creates permitted from pre-authorized certificates only\u0027.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_SearchParam": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the search parameter used in the interface.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.", - "$ref": "#/definitions/canonical" - }, - "type": { - "description": "The type of value a search parameter refers to, and how the content is interpreted.", - "enum": [ - "number", - "date", - "string", - "token", - "reference", - "composite", - "quantity", - "uri", - "special" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Operation": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [[[OperationDefinition]]] with a \u0027base\u0027 of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.", - "$ref": "#/definitions/canonical" - }, - "documentation": { - "description": "Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "definition" - ] - }, - "CapabilityStatement_Interaction1": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A coded identifier of the operation, supported by the system.", - "enum": [ - "transaction", - "batch", - "search-system", - "history-system" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Messaging": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "endpoint": { - "description": "An endpoint (network accessible address) to which messages and/or replies are to be sent.", - "items": { - "$ref": "#/definitions/CapabilityStatement_Endpoint" - }, - "type": "array" - }, - "reliableCache": { - "description": "Length if the receiver\u0027s reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).", - "$ref": "#/definitions/unsignedInt" - }, - "_reliableCache": { - "description": "Extensions for reliableCache", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Documentation about the system\u0027s messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "supportedMessage": { - "description": "References to message definitions for messages this system can send or receive.", - "items": { - "$ref": "#/definitions/CapabilityStatement_SupportedMessage" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "CapabilityStatement_Endpoint": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "protocol": { - "description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.", - "$ref": "#/definitions/Coding" - }, - "address": { - "description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.", - "$ref": "#/definitions/url" - }, - "_address": { - "description": "Extensions for address", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "protocol" - ] - }, - "CapabilityStatement_SupportedMessage": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "The mode of this event declaration - whether application is sender or receiver.", - "enum": [ - "sender", - "receiver" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "definition" - ] - }, - "CapabilityStatement_Document": { - "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "Mode of this document declaration - whether an application is a producer or consumer.", - "enum": [ - "producer", - "consumer" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.", - "$ref": "#/definitions/markdown" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A profile on the document Bundle that constrains which resources are present, and their contents.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "profile" - ] - }, - "CarePlan": { - "description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", - "properties": { - "resourceType": { - "description": "This is a CarePlan resource", - "const": "CarePlan" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "A care plan that is fulfilled in whole or in part by this care plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "replaces": { - "description": "Completed or terminated care plan whose function is taken by this new care plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger care plan of which this particular care plan is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "intent": { - "description": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "title": { - "description": "Human-friendly name for the care plan.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A description of the scope and nature of the plan.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "Identifies the patient or group whose intended care is described by the plan.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "Indicates when the plan did (or is intended to) come into effect and end.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "When populated, the author is responsible for the care plan. The care plan is attributed to the author.", - "$ref": "#/definitions/Reference" - }, - "contributor": { - "description": "Identifies the individual(s) or organization who provided the contents of the care plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "careTeam": { - "description": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "addresses": { - "description": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Identifies portions of the patient\u0027s record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "goal": { - "description": "Describes the intended objective(s) of carrying out the care plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "activity": { - "description": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.", - "items": { - "$ref": "#/definitions/CarePlan_Activity" - }, - "type": "array" - }, - "note": { - "description": "General notes about the care plan not covered elsewhere.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "CarePlan_Activity": { - "description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "outcomeCodeableConcept": { - "description": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "outcomeReference": { - "description": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "progress": { - "description": "Notes about the adherence/status/progress of the activity.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "reference": { - "description": "The details of the proposed activity represented in a specific resource.", - "$ref": "#/definitions/Reference" - }, - "detail": { - "description": "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn\u0027t know about specific resources such as procedure etc.", - "$ref": "#/definitions/CarePlan_Detail" - } - }, - "additionalProperties": false - }, - "CarePlan_Detail": { - "description": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "kind": { - "description": "A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.", - "$ref": "#/definitions/code" - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "code": { - "description": "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.", - "$ref": "#/definitions/CodeableConcept" - }, - "reasonCode": { - "description": "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "goal": { - "description": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "Identifies what progress is being made for the specific activity.", - "enum": [ - "not-started", - "scheduled", - "in-progress", - "on-hold", - "completed", - "cancelled", - "stopped", - "unknown", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Provides reason why the activity isn\u0027t yet started, is on hold, was cancelled, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "doNotPerform": { - "description": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "scheduledTiming": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Timing" - }, - "scheduledPeriod": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "$ref": "#/definitions/Period" - }, - "scheduledString": { - "description": "The period, timing or frequency upon which the described activity is to occur.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_scheduledString": { - "description": "Extensions for scheduledString", - "$ref": "#/definitions/Element" - }, - "location": { - "description": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.", - "$ref": "#/definitions/Reference" - }, - "performer": { - "description": "Identifies who\u0027s expected to be involved in the activity.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "productCodeableConcept": { - "description": "Identifies the food, drug or other product to be consumed or supplied in the activity.", - "$ref": "#/definitions/CodeableConcept" - }, - "productReference": { - "description": "Identifies the food, drug or other product to be consumed or supplied in the activity.", - "$ref": "#/definitions/Reference" - }, - "dailyAmount": { - "description": "Identifies the quantity expected to be consumed in a given day.", - "$ref": "#/definitions/Quantity" - }, - "quantity": { - "description": "Identifies the quantity expected to be supplied, administered or consumed by the subject.", - "$ref": "#/definitions/Quantity" - }, - "description": { - "description": "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CareTeam": { - "description": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.", - "properties": { - "resourceType": { - "description": "This is a CareTeam resource", - "const": "CareTeam" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the current state of the care team.", - "enum": [ - "proposed", - "active", - "suspended", - "inactive", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "name": { - "description": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "Identifies the patient or group whose intended care is handled by the team.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "Indicates when the team did (or is intended to) come into effect and end.", - "$ref": "#/definitions/Period" - }, - "participant": { - "description": "Identifies all people and organizations who are expected to be involved in the care team.", - "items": { - "$ref": "#/definitions/CareTeam_Participant" - }, - "type": "array" - }, - "reasonCode": { - "description": "Describes why the care team exists.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Condition(s) that this care team addresses.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "managingOrganization": { - "description": "The organization responsible for the care team.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "telecom": { - "description": "A central contact detail for the care team (that applies to all members).", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "note": { - "description": "Comments made about the CareTeam.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "CareTeam_Participant": { - "description": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "role": { - "description": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "member": { - "description": "The specific person or organization who is participating/expected to participate in the care team.", - "$ref": "#/definitions/Reference" - }, - "onBehalfOf": { - "description": "The organization of the practitioner.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "Indicates when the specific member or organization did (or is intended to) come into effect and end.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "CatalogEntry": { - "description": "Catalog entries are wrappers that contextualize items included in a catalog.", - "properties": { - "resourceType": { - "description": "This is a CatalogEntry resource", - "const": "CatalogEntry" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "The type of item - medication, device, service, protocol or other.", - "$ref": "#/definitions/CodeableConcept" - }, - "orderable": { - "description": "Whether the entry represents an orderable item.", - "$ref": "#/definitions/boolean" - }, - "_orderable": { - "description": "Extensions for orderable", - "$ref": "#/definitions/Element" - }, - "referencedItem": { - "description": "The item in a catalog or definition.", - "$ref": "#/definitions/Reference" - }, - "additionalIdentifier": { - "description": "Used in supporting related concepts, e.g. NDC to RxNorm.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "classification": { - "description": "Classes of devices, or ATC for medication.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "status": { - "description": "Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "validityPeriod": { - "description": "The time period in which this catalog entry is expected to be active.", - "$ref": "#/definitions/Period" - }, - "validTo": { - "description": "The date until which this catalog entry is expected to be active.", - "$ref": "#/definitions/dateTime" - }, - "_validTo": { - "description": "Extensions for validTo", - "$ref": "#/definitions/Element" - }, - "lastUpdated": { - "description": "Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.", - "$ref": "#/definitions/dateTime" - }, - "_lastUpdated": { - "description": "Extensions for lastUpdated", - "$ref": "#/definitions/Element" - }, - "additionalCharacteristic": { - "description": "Used for examplefor Out of Formulary, or any specifics.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "additionalClassification": { - "description": "User for example for ATC classification, or.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "relatedEntry": { - "description": "Used for example, to point to a substance, or to a device used to administer a medication.", - "items": { - "$ref": "#/definitions/CatalogEntry_RelatedEntry" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType", - "referencedItem" - ] - }, - "CatalogEntry_RelatedEntry": { - "description": "Catalog entries are wrappers that contextualize items included in a catalog.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "relationtype": { - "description": "The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.", - "enum": [ - "triggers", - "is-replaced-by" - ] - }, - "_relationtype": { - "description": "Extensions for relationtype", - "$ref": "#/definitions/Element" - }, - "item": { - "description": "The reference to the related item.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "item" - ] - }, - "ChargeItem": { - "description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", - "properties": { - "resourceType": { - "description": "This is a ChargeItem resource", - "const": "ChargeItem" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this event performer or other systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "definitionUri": { - "description": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_definitionUri": { - "description": "Extensions for definitionUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "definitionCanonical": { - "description": "References the source of pricing information, rules of application for the code this ChargeItem uses.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "status": { - "description": "The current state of the ChargeItem.", - "enum": [ - "planned", - "billable", - "not-billable", - "aborted", - "billed", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "partOf": { - "description": "ChargeItems can be grouped to larger ChargeItems covering the whole set.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "code": { - "description": "A code that identifies the charge, like a billing code.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The individual or set of individuals the action is being or was performed on.", - "$ref": "#/definitions/Reference" - }, - "context": { - "description": "The encounter or episode of care that establishes the context for this event.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "Date/time(s) or duration when the charged service was applied.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "Date/time(s) or duration when the charged service was applied.", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "Date/time(s) or duration when the charged service was applied.", - "$ref": "#/definitions/Timing" - }, - "performer": { - "description": "Indicates who or what performed or participated in the charged service.", - "items": { - "$ref": "#/definitions/ChargeItem_Performer" - }, - "type": "array" - }, - "performingOrganization": { - "description": "The organization requesting the service.", - "$ref": "#/definitions/Reference" - }, - "requestingOrganization": { - "description": "The organization performing the service.", - "$ref": "#/definitions/Reference" - }, - "costCenter": { - "description": "The financial cost center permits the tracking of charge attribution.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "Quantity of which the charge item has been serviced.", - "$ref": "#/definitions/Quantity" - }, - "bodysite": { - "description": "The anatomical location where the related service has been applied.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "factorOverride": { - "description": "Factor overriding the factor determined by the rules associated with the code.", - "$ref": "#/definitions/decimal" - }, - "_factorOverride": { - "description": "Extensions for factorOverride", - "$ref": "#/definitions/Element" - }, - "priceOverride": { - "description": "Total price of the charge overriding the list price associated with the code.", - "$ref": "#/definitions/Money" - }, - "overrideReason": { - "description": "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.", - "$ref": "#/definitions/string" - }, - "_overrideReason": { - "description": "Extensions for overrideReason", - "$ref": "#/definitions/Element" - }, - "enterer": { - "description": "The device, practitioner, etc. who entered the charge item.", - "$ref": "#/definitions/Reference" - }, - "enteredDate": { - "description": "Date the charge item was entered.", - "$ref": "#/definitions/dateTime" - }, - "_enteredDate": { - "description": "Extensions for enteredDate", - "$ref": "#/definitions/Element" - }, - "reason": { - "description": "Describes why the event occurred in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "service": { - "description": "Indicated the rendered service that caused this charge.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "productReference": { - "description": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", - "$ref": "#/definitions/Reference" - }, - "productCodeableConcept": { - "description": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.", - "$ref": "#/definitions/CodeableConcept" - }, - "account": { - "description": "Account into which this ChargeItems belongs.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Comments made about the event by the performer, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "supportingInformation": { - "description": "Further information supporting this charge.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code", - "subject", - "resourceType" - ] - }, - "ChargeItem_Performer": { - "description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "The device, practitioner, etc. who performed or participated in the service.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "ChargeItemDefinition": { - "description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.", - "properties": { - "resourceType": { - "description": "This is a ChargeItemDefinition resource", - "const": "ChargeItemDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the charge item definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "derivedFromUri": { - "description": "The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_derivedFromUri": { - "description": "Extensions for derivedFromUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "partOf": { - "description": "A larger definition of which this particular definition is a component or step.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "replaces": { - "description": "As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "status": { - "description": "The current state of the ChargeItemDefinition.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the charge item definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the charge item definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the charge item definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the charge item definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "code": { - "description": "The defined billing details in this resource pertain to the given billing code.", - "$ref": "#/definitions/CodeableConcept" - }, - "instance": { - "description": "The defined billing details in this resource pertain to the given product instance(s).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "applicability": { - "description": "Expressions that describe applicability criteria for the billing code.", - "items": { - "$ref": "#/definitions/ChargeItemDefinition_Applicability" - }, - "type": "array" - }, - "propertyGroup": { - "description": "Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.", - "items": { - "$ref": "#/definitions/ChargeItemDefinition_PropertyGroup" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ChargeItemDefinition_Applicability": { - "description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "A brief, natural language description of the condition that effectively communicates the intended semantics.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The media type of the language for the expression, e.g. \"text/cql\" for Clinical Query Language expressions or \"text/fhirpath\" for FHIRPath expressions.", - "$ref": "#/definitions/string" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ChargeItemDefinition_PropertyGroup": { - "description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "applicability": { - "description": "Expressions that describe applicability criteria for the priceComponent.", - "items": { - "$ref": "#/definitions/ChargeItemDefinition_Applicability" - }, - "type": "array" - }, - "priceComponent": { - "description": "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.", - "items": { - "$ref": "#/definitions/ChargeItemDefinition_PriceComponent" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ChargeItemDefinition_PriceComponent": { - "description": "The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "This code identifies the type of the component.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "factor": { - "description": "The factor that has been applied on the base price for calculating this component.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "The amount calculated for this component.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false - }, - "Claim": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "resourceType": { - "description": "This is a Claim resource", - "const": "Claim" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this claim.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.", - "$ref": "#/definitions/CodeableConcept" - }, - "use": { - "description": "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.", - "enum": [ - "claim", - "preauthorization", - "predetermination" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.", - "$ref": "#/definitions/Reference" - }, - "billablePeriod": { - "description": "The period for which charges are being submitted.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "The date this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "enterer": { - "description": "Individual who created the claim, predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "insurer": { - "description": "The Insurer who is target of the request.", - "$ref": "#/definitions/Reference" - }, - "provider": { - "description": "The provider which is responsible for the claim, predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "priority": { - "description": "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.", - "$ref": "#/definitions/CodeableConcept" - }, - "fundsReserve": { - "description": "A code to indicate whether and for whom funds are to be reserved for future claims.", - "$ref": "#/definitions/CodeableConcept" - }, - "related": { - "description": "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.", - "items": { - "$ref": "#/definitions/Claim_Related" - }, - "type": "array" - }, - "prescription": { - "description": "Prescription to support the dispensing of pharmacy, device or vision products.", - "$ref": "#/definitions/Reference" - }, - "originalPrescription": { - "description": "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.", - "$ref": "#/definitions/Reference" - }, - "payee": { - "description": "The party to be reimbursed for cost of the products and services according to the terms of the policy.", - "$ref": "#/definitions/Claim_Payee" - }, - "referral": { - "description": "A reference to a referral resource.", - "$ref": "#/definitions/Reference" - }, - "facility": { - "description": "Facility where the services were provided.", - "$ref": "#/definitions/Reference" - }, - "careTeam": { - "description": "The members of the team who provided the products and services.", - "items": { - "$ref": "#/definitions/Claim_CareTeam" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.", - "items": { - "$ref": "#/definitions/Claim_SupportingInfo" - }, - "type": "array" - }, - "diagnosis": { - "description": "Information about diagnoses relevant to the claim items.", - "items": { - "$ref": "#/definitions/Claim_Diagnosis" - }, - "type": "array" - }, - "procedure": { - "description": "Procedures performed on the patient relevant to the billing items with the claim.", - "items": { - "$ref": "#/definitions/Claim_Procedure" - }, - "type": "array" - }, - "insurance": { - "description": "Financial instruments for reimbursement for the health care products and services specified on the claim.", - "items": { - "$ref": "#/definitions/Claim_Insurance" - }, - "type": "array" - }, - "accident": { - "description": "Details of an accident which resulted in injuries which required the products and services listed in the claim.", - "$ref": "#/definitions/Claim_Accident" - }, - "item": { - "description": "A claim line. Either a simple product or service or a \u0027group\u0027 of details which can each be a simple items or groups of sub-details.", - "items": { - "$ref": "#/definitions/Claim_Item" - }, - "type": "array" - }, - "total": { - "description": "The total value of the all the items in the claim.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "insurance", - "provider", - "patient", - "type", - "priority", - "resourceType" - ] - }, - "Claim_Related": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "claim": { - "description": "Reference to a related claim.", - "$ref": "#/definitions/Reference" - }, - "relationship": { - "description": "A code to convey how the claims are related.", - "$ref": "#/definitions/CodeableConcept" - }, - "reference": { - "description": "An alternate organizational reference to the case or file to which this particular claim pertains.", - "$ref": "#/definitions/Identifier" - } - }, - "additionalProperties": false - }, - "Claim_Payee": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of Party to be reimbursed: subscriber, provider, other.", - "$ref": "#/definitions/CodeableConcept" - }, - "party": { - "description": "Reference to the individual or organization to whom any payment will be made.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "Claim_CareTeam": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify care team entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "provider": { - "description": "Member of the team who provided the product or service.", - "$ref": "#/definitions/Reference" - }, - "responsible": { - "description": "The party who is billing and/or responsible for the claimed products or services.", - "$ref": "#/definitions/boolean" - }, - "_responsible": { - "description": "Extensions for responsible", - "$ref": "#/definitions/Element" - }, - "role": { - "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.", - "$ref": "#/definitions/CodeableConcept" - }, - "qualification": { - "description": "The qualification of the practitioner which is applicable for this service.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "provider" - ] - }, - "Claim_SupportingInfo": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify supporting information entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "The general class of the information supplied: information; exception; accident, employment; onset, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.", - "$ref": "#/definitions/CodeableConcept" - }, - "timingDate": { - "description": "The date when or period to which this information refers.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_timingDate": { - "description": "Extensions for timingDate", - "$ref": "#/definitions/Element" - }, - "timingPeriod": { - "description": "The date when or period to which this information refers.", - "$ref": "#/definitions/Period" - }, - "valueBoolean": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueQuantity": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Quantity" - }, - "valueAttachment": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Attachment" - }, - "valueReference": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Reference" - }, - "reason": { - "description": "Provides the reason in the situation where a reason code is required in addition to the content.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "Claim_Diagnosis": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify diagnosis entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "diagnosisCodeableConcept": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/CodeableConcept" - }, - "diagnosisReference": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "When the condition was observed or the relative ranking.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "onAdmission": { - "description": "Indication of whether the diagnosis was present on admission to a facility.", - "$ref": "#/definitions/CodeableConcept" - }, - "packageCode": { - "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "Claim_Procedure": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify procedure entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "When the condition was observed or the relative ranking.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "date": { - "description": "Date and optionally time the procedure was performed.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "procedureCodeableConcept": { - "description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "procedureReference": { - "description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.", - "$ref": "#/definitions/Reference" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Claim_Insurance": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "focal": { - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.", - "$ref": "#/definitions/boolean" - }, - "_focal": { - "description": "Extensions for focal", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "The business identifier to be used when the claim is sent for adjudication against this insurance policy.", - "$ref": "#/definitions/Identifier" - }, - "coverage": { - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.", - "$ref": "#/definitions/Reference" - }, - "businessArrangement": { - "description": "A business agreement number established between the provider and the insurer for special business processing purposes.", - "$ref": "#/definitions/string" - }, - "_businessArrangement": { - "description": "Extensions for businessArrangement", - "$ref": "#/definitions/Element" - }, - "preAuthRef": { - "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_preAuthRef": { - "description": "Extensions for preAuthRef", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "claimResponse": { - "description": "The result of the adjudication of the line items for the Coverage specified in this insurance.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "Claim_Accident": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "date": { - "description": "Date of an accident event related to the products and services contained in the claim.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "The physical location of the accident event.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "The physical location of the accident event.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Claim_Item": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify item entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "careTeamSequence": { - "description": "CareTeam members related to this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_careTeamSequence": { - "description": "Extensions for careTeamSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "diagnosisSequence": { - "description": "Diagnosis applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_diagnosisSequence": { - "description": "Extensions for diagnosisSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "procedureSequence": { - "description": "Procedures applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_procedureSequence": { - "description": "Extensions for procedureSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "informationSequence": { - "description": "Exceptions, special conditions and supporting information applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_informationSequence": { - "description": "Extensions for informationSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "servicedDate": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "$ref": "#/definitions/Period" - }, - "locationCodeableConcept": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "Physical service site on the patient (limb, tooth, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "subSite": { - "description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "encounter": { - "description": "The Encounters during which this Claim was created or to which the creation of this record is tightly associated.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "detail": { - "description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.", - "items": { - "$ref": "#/definitions/Claim_Detail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "Claim_Detail": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify item entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "subDetail": { - "description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.", - "items": { - "$ref": "#/definitions/Claim_SubDetail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "Claim_SubDetail": { - "description": "A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify item entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ClaimResponse": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "resourceType": { - "description": "This is a ClaimResponse resource", - "const": "ClaimResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this claim response.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.", - "$ref": "#/definitions/CodeableConcept" - }, - "use": { - "description": "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.", - "$ref": "#/definitions/code" - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.", - "$ref": "#/definitions/Reference" - }, - "created": { - "description": "The date this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "insurer": { - "description": "The party responsible for authorization, adjudication and reimbursement.", - "$ref": "#/definitions/Reference" - }, - "requestor": { - "description": "The provider which is responsible for the claim, predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "request": { - "description": "Original request resource reference.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "The outcome of the claim, predetermination, or preauthorization processing.", - "$ref": "#/definitions/code" - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "disposition": { - "description": "A human readable description of the status of the adjudication.", - "$ref": "#/definitions/string" - }, - "_disposition": { - "description": "Extensions for disposition", - "$ref": "#/definitions/Element" - }, - "preAuthRef": { - "description": "Reference from the Insurer which is used in later communications which refers to this adjudication.", - "$ref": "#/definitions/string" - }, - "_preAuthRef": { - "description": "Extensions for preAuthRef", - "$ref": "#/definitions/Element" - }, - "preAuthPeriod": { - "description": "The time frame during which this authorization is effective.", - "$ref": "#/definitions/Period" - }, - "payeeType": { - "description": "Type of Party to be reimbursed: subscriber, provider, other.", - "$ref": "#/definitions/CodeableConcept" - }, - "item": { - "description": "A claim line. Either a simple (a product or service) or a \u0027group\u0027 of details which can also be a simple items or groups of sub-details.", - "items": { - "$ref": "#/definitions/ClaimResponse_Item" - }, - "type": "array" - }, - "addItem": { - "description": "The first-tier service adjudications for payor added product or service lines.", - "items": { - "$ref": "#/definitions/ClaimResponse_AddItem" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results which are presented at the header level rather than at the line-item or add-item levels.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - }, - "total": { - "description": "Categorized monetary totals for the adjudication.", - "items": { - "$ref": "#/definitions/ClaimResponse_Total" - }, - "type": "array" - }, - "payment": { - "description": "Payment details for the adjudication of the claim.", - "$ref": "#/definitions/ClaimResponse_Payment" - }, - "fundsReserve": { - "description": "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.", - "$ref": "#/definitions/CodeableConcept" - }, - "formCode": { - "description": "A code for the form to be used for printing the content.", - "$ref": "#/definitions/CodeableConcept" - }, - "form": { - "description": "The actual form, by reference or inclusion, for printing the content or an EOB.", - "$ref": "#/definitions/Attachment" - }, - "processNote": { - "description": "A note that describes or explains adjudication results in a human readable form.", - "items": { - "$ref": "#/definitions/ClaimResponse_ProcessNote" - }, - "type": "array" - }, - "communicationRequest": { - "description": "Request for additional supporting or authorizing information.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "insurance": { - "description": "Financial instruments for reimbursement for the health care products and services specified on the claim.", - "items": { - "$ref": "#/definitions/ClaimResponse_Insurance" - }, - "type": "array" - }, - "error": { - "description": "Errors encountered during the processing of the adjudication.", - "items": { - "$ref": "#/definitions/ClaimResponse_Error" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "insurer", - "type", - "resourceType" - ] - }, - "ClaimResponse_Item": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemSequence": { - "description": "A number to uniquely reference the claim item entries.", - "$ref": "#/definitions/positiveInt" - }, - "_itemSequence": { - "description": "Extensions for itemSequence", - "$ref": "#/definitions/Element" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - }, - "detail": { - "description": "A claim detail. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.", - "items": { - "$ref": "#/definitions/ClaimResponse_Detail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "adjudication" - ] - }, - "ClaimResponse_Adjudication": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item.", - "$ref": "#/definitions/CodeableConcept" - }, - "reason": { - "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Monetary amount associated with the category.", - "$ref": "#/definitions/Money" - }, - "value": { - "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "ClaimResponse_Detail": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "detailSequence": { - "description": "A number to uniquely reference the claim detail entry.", - "$ref": "#/definitions/positiveInt" - }, - "_detailSequence": { - "description": "Extensions for detailSequence", - "$ref": "#/definitions/Element" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - }, - "subDetail": { - "description": "A sub-detail adjudication of a simple product or service.", - "items": { - "$ref": "#/definitions/ClaimResponse_SubDetail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "adjudication" - ] - }, - "ClaimResponse_SubDetail": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subDetailSequence": { - "description": "A number to uniquely reference the claim sub-detail entry.", - "$ref": "#/definitions/positiveInt" - }, - "_subDetailSequence": { - "description": "Extensions for subDetailSequence", - "$ref": "#/definitions/Element" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ClaimResponse_AddItem": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemSequence": { - "description": "Claim items which this service line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_itemSequence": { - "description": "Extensions for itemSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "detailSequence": { - "description": "The sequence number of the details within the claim item which this line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_detailSequence": { - "description": "Extensions for detailSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "subdetailSequence": { - "description": "The sequence number of the sub-details within the details within the claim item which this line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_subdetailSequence": { - "description": "Extensions for subdetailSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "provider": { - "description": "The providers who are authorized for the services rendered to the patient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "servicedDate": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "$ref": "#/definitions/Period" - }, - "locationCodeableConcept": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "bodySite": { - "description": "Physical service site on the patient (limb, tooth, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "subSite": { - "description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - }, - "detail": { - "description": "The second-tier service adjudications for payor added services.", - "items": { - "$ref": "#/definitions/ClaimResponse_Detail1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "adjudication", - "productOrService" - ] - }, - "ClaimResponse_Detail1": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - }, - "subDetail": { - "description": "The third-tier service adjudications for payor added services.", - "items": { - "$ref": "#/definitions/ClaimResponse_SubDetail1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "adjudication", - "productOrService" - ] - }, - "ClaimResponse_SubDetail1": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ClaimResponse_Adjudication" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "adjudication", - "productOrService" - ] - }, - "ClaimResponse_Total": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Monetary total amount associated with the category.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "amount", - "category" - ] - }, - "ClaimResponse_Payment": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Whether this represents partial or complete payment of the benefits payable.", - "$ref": "#/definitions/CodeableConcept" - }, - "adjustment": { - "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim\u0027s adjudication.", - "$ref": "#/definitions/Money" - }, - "adjustmentReason": { - "description": "Reason for the payment adjustment.", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "Estimated date the payment will be issued or the actual issue date of payment.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "Benefits payable less any payment adjustment.", - "$ref": "#/definitions/Money" - }, - "identifier": { - "description": "Issuer\u0027s unique identifier for the payment instrument.", - "$ref": "#/definitions/Identifier" - } - }, - "additionalProperties": false, - "required": [ - "amount", - "type" - ] - }, - "ClaimResponse_ProcessNote": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "number": { - "description": "A number to uniquely identify a note entry.", - "$ref": "#/definitions/positiveInt" - }, - "_number": { - "description": "Extensions for number", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The business purpose of the note text.", - "enum": [ - "display", - "print", - "printoper" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "The explanation or description associated with the processing.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "A code to define the language used in the text of the note.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ClaimResponse_Insurance": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "focal": { - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.", - "$ref": "#/definitions/boolean" - }, - "_focal": { - "description": "Extensions for focal", - "$ref": "#/definitions/Element" - }, - "coverage": { - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.", - "$ref": "#/definitions/Reference" - }, - "businessArrangement": { - "description": "A business agreement number established between the provider and the insurer for special business processing purposes.", - "$ref": "#/definitions/string" - }, - "_businessArrangement": { - "description": "Extensions for businessArrangement", - "$ref": "#/definitions/Element" - }, - "claimResponse": { - "description": "The result of the adjudication of the line items for the Coverage specified in this insurance.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "ClaimResponse_Error": { - "description": "This resource provides the adjudication details from the processing of a Claim resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemSequence": { - "description": "The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.", - "$ref": "#/definitions/positiveInt" - }, - "_itemSequence": { - "description": "Extensions for itemSequence", - "$ref": "#/definitions/Element" - }, - "detailSequence": { - "description": "The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.", - "$ref": "#/definitions/positiveInt" - }, - "_detailSequence": { - "description": "Extensions for detailSequence", - "$ref": "#/definitions/Element" - }, - "subDetailSequence": { - "description": "The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure.", - "$ref": "#/definitions/positiveInt" - }, - "_subDetailSequence": { - "description": "Extensions for subDetailSequence", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "An error code, from a specified code system, which details why the claim could not be adjudicated.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "ClinicalImpression": { - "description": "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient\u0027s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.", - "properties": { - "resourceType": { - "description": "This is a ClinicalImpression resource", - "const": "ClinicalImpression" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Identifies the workflow status of the assessment.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the ClinicalImpression.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "Categorizes the type of clinical assessment performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "The patient or group of individuals assessed as part of this record.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "effectiveDateTime": { - "description": "The point in time or period over which the subject was assessed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_effectiveDateTime": { - "description": "Extensions for effectiveDateTime", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The point in time or period over which the subject was assessed.", - "$ref": "#/definitions/Period" - }, - "date": { - "description": "Indicates when the documentation of the assessment was complete.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "assessor": { - "description": "The clinician performing the assessment.", - "$ref": "#/definitions/Reference" - }, - "previous": { - "description": "A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient\u0027s conditions changes.", - "$ref": "#/definitions/Reference" - }, - "problem": { - "description": "A list of the relevant problems/conditions for a patient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "investigation": { - "description": "One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.", - "items": { - "$ref": "#/definitions/ClinicalImpression_Investigation" - }, - "type": "array" - }, - "protocol": { - "description": "Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_protocol": { - "description": "Extensions for protocol", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "summary": { - "description": "A text summary of the investigations and the diagnosis.", - "$ref": "#/definitions/string" - }, - "_summary": { - "description": "Extensions for summary", - "$ref": "#/definitions/Element" - }, - "finding": { - "description": "Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.", - "items": { - "$ref": "#/definitions/ClinicalImpression_Finding" - }, - "type": "array" - }, - "prognosisCodeableConcept": { - "description": "Estimate of likely outcome.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "prognosisReference": { - "description": "RiskAssessment expressing likely outcome.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Information supporting the clinical impression.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "ClinicalImpression_Investigation": { - "description": "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient\u0027s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A name/code for the group (\"set\") of investigations. Typically, this will be something like \"signs\", \"symptoms\", \"clinical\", \"diagnostic\", but the list is not constrained, and others such groups such as (exposure|family|travel|nutritional) history may be used.", - "$ref": "#/definitions/CodeableConcept" - }, - "item": { - "description": "A record of a specific investigation that was undertaken.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "ClinicalImpression_Finding": { - "description": "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient\u0027s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemCodeableConcept": { - "description": "Specific text or code for finding or diagnosis, which may include ruled-out or resolved conditions.", - "$ref": "#/definitions/CodeableConcept" - }, - "itemReference": { - "description": "Specific reference for finding or diagnosis, which may include ruled-out or resolved conditions.", - "$ref": "#/definitions/Reference" - }, - "basis": { - "description": "Which investigations support finding or diagnosis.", - "$ref": "#/definitions/string" - }, - "_basis": { - "description": "Extensions for basis", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CodeSystem": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "resourceType": { - "description": "This is a CodeSystem resource", - "const": "CodeSystem" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the code system.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The date (and optionally time) when the code system resource was created or revised.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the code system.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the code system from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the code system is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this code system is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "caseSensitive": { - "description": "If code comparison is case sensitive when codes within this system are compared to each other.", - "$ref": "#/definitions/boolean" - }, - "_caseSensitive": { - "description": "Extensions for caseSensitive", - "$ref": "#/definitions/Element" - }, - "valueSet": { - "description": "Canonical reference to the value set that contains the entire code system.", - "$ref": "#/definitions/canonical" - }, - "hierarchyMeaning": { - "description": "The meaning of the hierarchy of concepts as represented in this resource.", - "enum": [ - "grouped-by", - "is-a", - "part-of", - "classified-with" - ] - }, - "_hierarchyMeaning": { - "description": "Extensions for hierarchyMeaning", - "$ref": "#/definitions/Element" - }, - "compositional": { - "description": "The code system defines a compositional (post-coordination) grammar.", - "$ref": "#/definitions/boolean" - }, - "_compositional": { - "description": "Extensions for compositional", - "$ref": "#/definitions/Element" - }, - "versionNeeded": { - "description": "This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.", - "$ref": "#/definitions/boolean" - }, - "_versionNeeded": { - "description": "Extensions for versionNeeded", - "$ref": "#/definitions/Element" - }, - "content": { - "description": "The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.", - "enum": [ - "not-present", - "example", - "fragment", - "complete", - "supplement" - ] - }, - "_content": { - "description": "Extensions for content", - "$ref": "#/definitions/Element" - }, - "supplements": { - "description": "The canonical URL of the code system that this code system supplement is adding designations and properties to.", - "$ref": "#/definitions/canonical" - }, - "count": { - "description": "The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.", - "$ref": "#/definitions/unsignedInt" - }, - "_count": { - "description": "Extensions for count", - "$ref": "#/definitions/Element" - }, - "filter": { - "description": "A filter that can be used in a value set compose statement when selecting concepts using a filter.", - "items": { - "$ref": "#/definitions/CodeSystem_Filter" - }, - "type": "array" - }, - "property": { - "description": "A property defines an additional slot through which additional information can be provided about a concept.", - "items": { - "$ref": "#/definitions/CodeSystem_Property" - }, - "type": "array" - }, - "concept": { - "description": "Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.", - "items": { - "$ref": "#/definitions/CodeSystem_Concept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "CodeSystem_Filter": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The code that identifies this filter when it is used as a filter in [[[ValueSet]]].compose.include.filter.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A description of how or why the filter is used.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "operator": { - "description": "A list of operators that can be used with the filter.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_operator": { - "description": "Extensions for operator", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "value": { - "description": "A description of what the value for the filter should be.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CodeSystem_Property": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "uri": { - "description": "Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.", - "$ref": "#/definitions/uri" - }, - "_uri": { - "description": "Extensions for uri", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A description of the property- why it is defined, and how its value might be used.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of the property value. Properties of type \"code\" contain a code defined by the code system (e.g. a reference to another defined concept).", - "enum": [ - "code", - "Coding", - "string", - "integer", - "boolean", - "dateTime", - "decimal" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CodeSystem_Concept": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code - a text symbol - that uniquely identifies the concept within the code system.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "A human readable string that is the recommended default way to present this concept to a user.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.", - "$ref": "#/definitions/string" - }, - "_definition": { - "description": "Extensions for definition", - "$ref": "#/definitions/Element" - }, - "designation": { - "description": "Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.", - "items": { - "$ref": "#/definitions/CodeSystem_Designation" - }, - "type": "array" - }, - "property": { - "description": "A property value for this concept.", - "items": { - "$ref": "#/definitions/CodeSystem_Property1" - }, - "type": "array" - }, - "concept": { - "description": "Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.", - "items": { - "$ref": "#/definitions/CodeSystem_Concept" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "CodeSystem_Designation": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "language": { - "description": "The language this designation is defined for.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "use": { - "description": "A code that details how this designation would be used.", - "$ref": "#/definitions/Coding" - }, - "value": { - "description": "The text value for this designation.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CodeSystem_Property1": { - "description": "The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code that is a reference to CodeSystem.property.code.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "The value of this property.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueCoding": { - "description": "The value of this property.", - "$ref": "#/definitions/Coding" - }, - "valueString": { - "description": "The value of this property.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The value of this property.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The value of this property.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The value of this property.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The value of this property.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Communication": { - "description": "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.", - "properties": { - "resourceType": { - "description": "This is a Communication resource", - "const": "Communication" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "An order, proposal or plan fulfilled in whole or in part by this Communication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "Part of this action.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "inResponseTo": { - "description": "Prior communication that this communication is in response to.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The status of the transmission.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the Communication.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "The type of message conveyed such as alert, notification, reminder, instruction, etc.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "priority": { - "description": "Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "medium": { - "description": "A channel that was used for this communication (e.g. email, fax).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "subject": { - "description": "The patient or group that was the focus of this communication.", - "$ref": "#/definitions/Reference" - }, - "topic": { - "description": "Description of the purpose/content, similar to a subject line in an email.", - "$ref": "#/definitions/CodeableConcept" - }, - "about": { - "description": "Other resources that pertain to this communication and to which this communication should be associated.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "encounter": { - "description": "The Encounter during which this Communication was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "sent": { - "description": "The time when this communication was sent.", - "$ref": "#/definitions/dateTime" - }, - "_sent": { - "description": "Extensions for sent", - "$ref": "#/definitions/Element" - }, - "received": { - "description": "The time when this communication arrived at the destination.", - "$ref": "#/definitions/dateTime" - }, - "_received": { - "description": "Extensions for received", - "$ref": "#/definitions/Element" - }, - "recipient": { - "description": "The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "sender": { - "description": "The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "The reason or justification for the communication.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies this communication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "payload": { - "description": "Text, attachment(s), or resource(s) that was communicated to the recipient.", - "items": { - "$ref": "#/definitions/Communication_Payload" - }, - "type": "array" - }, - "note": { - "description": "Additional notes or commentary about the communication by the sender, receiver or other interested parties.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Communication_Payload": { - "description": "An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentString": { - "description": "A communicated content (or for multi-part communications, one portion of the communication).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_contentString": { - "description": "Extensions for contentString", - "$ref": "#/definitions/Element" - }, - "contentAttachment": { - "description": "A communicated content (or for multi-part communications, one portion of the communication).", - "$ref": "#/definitions/Attachment" - }, - "contentReference": { - "description": "A communicated content (or for multi-part communications, one portion of the communication).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "CommunicationRequest": { - "description": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.", - "properties": { - "resourceType": { - "description": "This is a CommunicationRequest resource", - "const": "CommunicationRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan or proposal that is fulfilled in whole or in part by this request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "replaces": { - "description": "Completed or terminated request(s) whose function is taken by this new request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "groupIdentifier": { - "description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The status of the proposal or order.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the CommunicationRequest.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "The type of message to be sent such as alert, notification, reminder, instruction, etc.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "priority": { - "description": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "doNotPerform": { - "description": "If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "medium": { - "description": "A channel that was used for this communication (e.g. email, fax).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "subject": { - "description": "The patient or group that is the focus of this communication request.", - "$ref": "#/definitions/Reference" - }, - "about": { - "description": "Other resources that pertain to this communication request and to which this communication request should be associated.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "encounter": { - "description": "The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "payload": { - "description": "Text, attachment(s), or resource(s) to be communicated to the recipient.", - "items": { - "$ref": "#/definitions/CommunicationRequest_Payload" - }, - "type": "array" - }, - "occurrenceDateTime": { - "description": "The time when this communication is to occur.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "The time when this communication is to occur.", - "$ref": "#/definitions/Period" - }, - "authoredOn": { - "description": "For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The device, individual, or organization who initiated the request and has responsibility for its activation.", - "$ref": "#/definitions/Reference" - }, - "recipient": { - "description": "The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "sender": { - "description": "The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Describes why the request is being made in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies this request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Comments made about the request by the requester, sender, recipient, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "CommunicationRequest_Payload": { - "description": "A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentString": { - "description": "The communicated content (or for multi-part communications, one portion of the communication).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_contentString": { - "description": "Extensions for contentString", - "$ref": "#/definitions/Element" - }, - "contentAttachment": { - "description": "The communicated content (or for multi-part communications, one portion of the communication).", - "$ref": "#/definitions/Attachment" - }, - "contentReference": { - "description": "The communicated content (or for multi-part communications, one portion of the communication).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "CompartmentDefinition": { - "description": "A compartment definition that defines how resources are accessed on a server.", - "properties": { - "resourceType": { - "description": "This is a CompartmentDefinition resource", - "const": "CompartmentDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this compartment definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the compartment definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the compartment definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this compartment definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Which compartment this definition describes.", - "enum": [ - "Patient", - "Encounter", - "RelatedPerson", - "Practitioner", - "Device" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "search": { - "description": "Whether the search syntax is supported,.", - "$ref": "#/definitions/boolean" - }, - "_search": { - "description": "Extensions for search", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "Information about how a resource is related to the compartment.", - "items": { - "$ref": "#/definitions/CompartmentDefinition_Resource" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "CompartmentDefinition_Resource": { - "description": "A compartment definition that defines how resources are accessed on a server.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The name of a resource supported by the server.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "param": { - "description": "The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_param": { - "description": "Extensions for param", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "documentation": { - "description": "Additional documentation about the resource and compartment.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Composition": { - "description": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type\u003ddocument, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", - "properties": { - "resourceType": { - "description": "This is a Composition resource", - "const": "Composition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.", - "enum": [ - "preliminary", - "final", - "amended", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "subject": { - "description": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "Describes the clinical encounter or type of care this documentation is associated with.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The composition editing time, when the composition was last logically changed by the author.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Identifies who is responsible for the information in the composition, not necessarily who typed it in.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "title": { - "description": "Official human-readable label for the composition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "confidentiality": { - "description": "The code specifying the level of confidentiality of the Composition.", - "$ref": "#/definitions/code" - }, - "_confidentiality": { - "description": "Extensions for confidentiality", - "$ref": "#/definitions/Element" - }, - "attester": { - "description": "A participant who has attested to the accuracy of the composition/document.", - "items": { - "$ref": "#/definitions/Composition_Attester" - }, - "type": "array" - }, - "custodian": { - "description": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.", - "$ref": "#/definitions/Reference" - }, - "relatesTo": { - "description": "Relationships that this composition has with other compositions or documents that already exist.", - "items": { - "$ref": "#/definitions/Composition_RelatesTo" - }, - "type": "array" - }, - "event": { - "description": "The clinical service, such as a colonoscopy or an appendectomy, being documented.", - "items": { - "$ref": "#/definitions/Composition_Event" - }, - "type": "array" - }, - "section": { - "description": "The root of the sections that make up the composition.", - "items": { - "$ref": "#/definitions/Composition_Section" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "author", - "type", - "resourceType" - ] - }, - "Composition_Attester": { - "description": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type\u003ddocument, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "The type of attestation the authenticator offers.", - "enum": [ - "personal", - "professional", - "legal", - "official" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "time": { - "description": "When the composition was attested by the party.", - "$ref": "#/definitions/dateTime" - }, - "_time": { - "description": "Extensions for time", - "$ref": "#/definitions/Element" - }, - "party": { - "description": "Who attested the composition in the specified way.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Composition_RelatesTo": { - "description": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type\u003ddocument, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The type of relationship that this composition has with anther composition or document.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "targetIdentifier": { - "description": "The target composition/document of this relationship.", - "$ref": "#/definitions/Identifier" - }, - "targetReference": { - "description": "The target composition/document of this relationship.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Composition_Event": { - "description": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type\u003ddocument, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "period": { - "description": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.", - "$ref": "#/definitions/Period" - }, - "detail": { - "description": "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Composition_Section": { - "description": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type\u003ddocument, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "title": { - "description": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", - "$ref": "#/definitions/CodeableConcept" - }, - "author": { - "description": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "focus": { - "description": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", - "$ref": "#/definitions/Reference" - }, - "text": { - "description": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", - "$ref": "#/definitions/Narrative" - }, - "mode": { - "description": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", - "$ref": "#/definitions/code" - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "orderedBy": { - "description": "Specifies the order applied to the items in the section entries.", - "$ref": "#/definitions/CodeableConcept" - }, - "entry": { - "description": "A reference to the actual resource from which the narrative in the section is derived.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "emptyReason": { - "description": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", - "$ref": "#/definitions/CodeableConcept" - }, - "section": { - "description": "A nested sub-section within this section.", - "items": { - "$ref": "#/definitions/Composition_Section" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ConceptMap": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "resourceType": { - "description": "This is a ConceptMap resource", - "const": "ConceptMap" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "$ref": "#/definitions/Identifier" - }, - "version": { - "description": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the concept map.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this concept map. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the concept map.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the concept map from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the concept map is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this concept map is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "sourceUri": { - "description": "Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.", - "pattern": "^\\S*$", - "type": "string" - }, - "_sourceUri": { - "description": "Extensions for sourceUri", - "$ref": "#/definitions/Element" - }, - "sourceCanonical": { - "description": "Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.", - "pattern": "^\\S*$", - "type": "string" - }, - "_sourceCanonical": { - "description": "Extensions for sourceCanonical", - "$ref": "#/definitions/Element" - }, - "targetUri": { - "description": "The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.", - "pattern": "^\\S*$", - "type": "string" - }, - "_targetUri": { - "description": "Extensions for targetUri", - "$ref": "#/definitions/Element" - }, - "targetCanonical": { - "description": "The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.", - "pattern": "^\\S*$", - "type": "string" - }, - "_targetCanonical": { - "description": "Extensions for targetCanonical", - "$ref": "#/definitions/Element" - }, - "group": { - "description": "A group of mappings that all have the same source and target system.", - "items": { - "$ref": "#/definitions/ConceptMap_Group" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ConceptMap_Group": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "source": { - "description": "An absolute URI that identifies the source system where the concepts to be mapped are defined.", - "$ref": "#/definitions/uri" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "sourceVersion": { - "description": "The specific version of the code system, as determined by the code system authority.", - "$ref": "#/definitions/string" - }, - "_sourceVersion": { - "description": "Extensions for sourceVersion", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "An absolute URI that identifies the target system that the concepts will be mapped to.", - "$ref": "#/definitions/uri" - }, - "_target": { - "description": "Extensions for target", - "$ref": "#/definitions/Element" - }, - "targetVersion": { - "description": "The specific version of the code system, as determined by the code system authority.", - "$ref": "#/definitions/string" - }, - "_targetVersion": { - "description": "Extensions for targetVersion", - "$ref": "#/definitions/Element" - }, - "element": { - "description": "Mappings for an individual concept in the source to one or more concepts in the target.", - "items": { - "$ref": "#/definitions/ConceptMap_Element" - }, - "type": "array" - }, - "unmapped": { - "description": "What to do when there is no mapping for the source concept. \"Unmapped\" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence \u003d unmatched.", - "$ref": "#/definitions/ConceptMap_Unmapped" - } - }, - "additionalProperties": false, - "required": [ - "element" - ] - }, - "ConceptMap_Element": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Identity (code or path) or the element/item being mapped.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The display for the code. The display is only provided to help editors when editing the concept map.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "A concept from the target value set that this concept maps to.", - "items": { - "$ref": "#/definitions/ConceptMap_Target" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ConceptMap_Target": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Identity (code or path) or the element/item that the map refers to.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The display for the code. The display is only provided to help editors when editing the concept map.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "equivalence": { - "description": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is \u0027wider\u0027 than the source).", - "enum": [ - "relatedto", - "equivalent", - "equal", - "wider", - "subsumes", - "narrower", - "specializes", - "inexact", - "unmatched", - "disjoint" - ] - }, - "_equivalence": { - "description": "Extensions for equivalence", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "A description of status/issues in mapping that conveys additional information not represented in the structured data.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "dependsOn": { - "description": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.", - "items": { - "$ref": "#/definitions/ConceptMap_DependsOn" - }, - "type": "array" - }, - "product": { - "description": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.", - "items": { - "$ref": "#/definitions/ConceptMap_DependsOn" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ConceptMap_DependsOn": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "property": { - "description": "A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.", - "$ref": "#/definitions/uri" - }, - "_property": { - "description": "Extensions for property", - "$ref": "#/definitions/Element" - }, - "system": { - "description": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).", - "$ref": "#/definitions/canonical" - }, - "value": { - "description": "Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The display for the code. The display is only provided to help editors when editing the concept map.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ConceptMap_Unmapped": { - "description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "mode": { - "description": "Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).", - "enum": [ - "provided", - "fixed", - "other-map" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "The fixed code to use when the mode \u003d \u0027fixed\u0027 - all unmapped codes are mapped to a single fixed code.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The display for the code. The display is only provided to help editors when editing the concept map.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false - }, - "Condition": { - "description": "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "properties": { - "resourceType": { - "description": "This is a Condition resource", - "const": "Condition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "clinicalStatus": { - "description": "The clinical status of the condition.", - "$ref": "#/definitions/CodeableConcept" - }, - "verificationStatus": { - "description": "The verification status to support the clinical status of the condition.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "A category assigned to the condition.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "severity": { - "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "Identification of the condition, problem or diagnosis.", - "$ref": "#/definitions/CodeableConcept" - }, - "bodySite": { - "description": "The anatomical location where this condition manifests itself.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "subject": { - "description": "Indicates the patient or group who the condition record is associated with.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "onsetDateTime": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_onsetDateTime": { - "description": "Extensions for onsetDateTime", - "$ref": "#/definitions/Element" - }, - "onsetAge": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "$ref": "#/definitions/Age" - }, - "onsetPeriod": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "$ref": "#/definitions/Period" - }, - "onsetRange": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "$ref": "#/definitions/Range" - }, - "onsetString": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_onsetString": { - "description": "Extensions for onsetString", - "$ref": "#/definitions/Element" - }, - "abatementDateTime": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_abatementDateTime": { - "description": "Extensions for abatementDateTime", - "$ref": "#/definitions/Element" - }, - "abatementAge": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", - "$ref": "#/definitions/Age" - }, - "abatementPeriod": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", - "$ref": "#/definitions/Period" - }, - "abatementRange": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", - "$ref": "#/definitions/Range" - }, - "abatementString": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_abatementString": { - "description": "Extensions for abatementString", - "$ref": "#/definitions/Element" - }, - "recordedDate": { - "description": "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", - "$ref": "#/definitions/dateTime" - }, - "_recordedDate": { - "description": "Extensions for recordedDate", - "$ref": "#/definitions/Element" - }, - "recorder": { - "description": "Individual who recorded the record and takes responsibility for its content.", - "$ref": "#/definitions/Reference" - }, - "asserter": { - "description": "Individual who is making the condition statement.", - "$ref": "#/definitions/Reference" - }, - "stage": { - "description": "Clinical stage or grade of a condition. May include formal severity assessments.", - "items": { - "$ref": "#/definitions/Condition_Stage" - }, - "type": "array" - }, - "evidence": { - "description": "Supporting evidence / manifestations that are the basis of the Condition\u0027s verification status, such as evidence that confirmed or refuted the condition.", - "items": { - "$ref": "#/definitions/Condition_Evidence" - }, - "type": "array" - }, - "note": { - "description": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "Condition_Stage": { - "description": "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "summary": { - "description": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.", - "$ref": "#/definitions/CodeableConcept" - }, - "assessment": { - "description": "Reference to a formal record of the evidence on which the staging assessment is based.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "type": { - "description": "The kind of staging, such as pathological or clinical staging.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "Condition_Evidence": { - "description": "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A manifestation or symptom that led to the recording of this condition.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "detail": { - "description": "Links to other relevant information, including pathology reports.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Consent": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "resourceType": { - "description": "This is a Consent resource", - "const": "Consent" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for this copy of the Consent Statement.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the current state of this consent.", - "enum": [ - "draft", - "proposed", - "active", - "rejected", - "inactive", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "scope": { - "description": "A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "patient": { - "description": "The patient/healthcare consumer to whom this consent applies.", - "$ref": "#/definitions/Reference" - }, - "dateTime": { - "description": "When this Consent was issued / created / indexed.", - "$ref": "#/definitions/dateTime" - }, - "_dateTime": { - "description": "Extensions for dateTime", - "$ref": "#/definitions/Element" - }, - "performer": { - "description": "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "organization": { - "description": "The organization that manages the consent, and the framework within which it is executed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "sourceAttachment": { - "description": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.", - "$ref": "#/definitions/Attachment" - }, - "sourceReference": { - "description": "The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.", - "$ref": "#/definitions/Reference" - }, - "policy": { - "description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.", - "items": { - "$ref": "#/definitions/Consent_Policy" - }, - "type": "array" - }, - "policyRule": { - "description": "A reference to the specific base computable regulation or policy.", - "$ref": "#/definitions/CodeableConcept" - }, - "verification": { - "description": "Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.", - "items": { - "$ref": "#/definitions/Consent_Verification" - }, - "type": "array" - }, - "provision": { - "description": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.", - "$ref": "#/definitions/Consent_Provision" - } - }, - "additionalProperties": false, - "required": [ - "scope", - "category", - "resourceType" - ] - }, - "Consent_Policy": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "authority": { - "description": "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.", - "$ref": "#/definitions/uri" - }, - "_authority": { - "description": "Extensions for authority", - "$ref": "#/definitions/Element" - }, - "uri": { - "description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.", - "$ref": "#/definitions/uri" - }, - "_uri": { - "description": "Extensions for uri", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Consent_Verification": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "verified": { - "description": "Has the instruction been verified.", - "$ref": "#/definitions/boolean" - }, - "_verified": { - "description": "Extensions for verified", - "$ref": "#/definitions/Element" - }, - "verifiedWith": { - "description": "Who verified the instruction (Patient, Relative or other Authorized Person).", - "$ref": "#/definitions/Reference" - }, - "verificationDate": { - "description": "Date verification was collected.", - "$ref": "#/definitions/dateTime" - }, - "_verificationDate": { - "description": "Extensions for verificationDate", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Consent_Provision": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.", - "enum": [ - "deny", - "permit" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The timeframe in this rule is valid.", - "$ref": "#/definitions/Period" - }, - "actor": { - "description": "Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. \u0027admitting officers\u0027).", - "items": { - "$ref": "#/definitions/Consent_Actor" - }, - "type": "array" - }, - "action": { - "description": "Actions controlled by this Rule.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "securityLabel": { - "description": "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "purpose": { - "description": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "class": { - "description": "The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "code": { - "description": "If this code is found in an instance, then the rule applies.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "dataPeriod": { - "description": "Clinical or Operational Relevant period of time that bounds the data controlled by this rule.", - "$ref": "#/definitions/Period" - }, - "data": { - "description": "The resources controlled by this rule if specific resources are referenced.", - "items": { - "$ref": "#/definitions/Consent_Data" - }, - "type": "array" - }, - "provision": { - "description": "Rules which provide exceptions to the base rule or subrules.", - "items": { - "$ref": "#/definitions/Consent_Provision" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Consent_Actor": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "role": { - "description": "How the individual is involved in the resources content that is described in the exception.", - "$ref": "#/definitions/CodeableConcept" - }, - "reference": { - "description": "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. \u0027admitting officers\u0027).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "reference", - "role" - ] - }, - "Consent_Data": { - "description": "A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "meaning": { - "description": "How the resource reference is interpreted when testing consent restrictions.", - "enum": [ - "instance", - "related", - "dependents", - "authoredby" - ] - }, - "_meaning": { - "description": "Extensions for meaning", - "$ref": "#/definitions/Element" - }, - "reference": { - "description": "A reference to a specific resource that defines which resources are covered by this consent.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "reference" - ] - }, - "Contract": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "resourceType": { - "description": "This is a Contract resource", - "const": "Contract" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for this Contract or a derivative that references a Source Contract.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "url": { - "description": "Canonical identifier for this contract, represented as a URI (globally unique).", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "An edition identifier used for business purposes to label business significant variants.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "legalState": { - "description": "Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.", - "$ref": "#/definitions/CodeableConcept" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.", - "$ref": "#/definitions/Reference" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.", - "$ref": "#/definitions/uri" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "$ref": "#/definitions/Element" - }, - "contentDerivative": { - "description": "The minimal content derived from the basal information source at a specific stage in its lifecycle.", - "$ref": "#/definitions/CodeableConcept" - }, - "issued": { - "description": "When this Contract was issued.", - "$ref": "#/definitions/dateTime" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "applies": { - "description": "Relevant time or time-period when this Contract is applicable.", - "$ref": "#/definitions/Period" - }, - "expirationType": { - "description": "Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The target entity impacted by or of interest to parties to the agreement.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "authority": { - "description": "A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "domain": { - "description": "Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "site": { - "description": "Sites in which the contract is complied with, exercised, or in force.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "name": { - "description": "A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_alias": { - "description": "Extensions for alias", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "author": { - "description": "The individual or organization that authored the Contract definition, derivative, or instance in any legal state.", - "$ref": "#/definitions/Reference" - }, - "scope": { - "description": "A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.", - "$ref": "#/definitions/CodeableConcept" - }, - "topicCodeableConcept": { - "description": "Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.", - "$ref": "#/definitions/CodeableConcept" - }, - "topicReference": { - "description": "Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract\u0027s scope to distinguish the kinds of systems that would be interested in the contract.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract\u0027s scope.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "contentDefinition": { - "description": "Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.", - "$ref": "#/definitions/Contract_ContentDefinition" - }, - "term": { - "description": "One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.", - "items": { - "$ref": "#/definitions/Contract_Term" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Information that may be needed by/relevant to the performer in their execution of this term action.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "relevantHistory": { - "description": "Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "signer": { - "description": "Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.", - "items": { - "$ref": "#/definitions/Contract_Signer" - }, - "type": "array" - }, - "friendly": { - "description": "The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.", - "items": { - "$ref": "#/definitions/Contract_Friendly" - }, - "type": "array" - }, - "legal": { - "description": "List of Legal expressions or representations of this Contract.", - "items": { - "$ref": "#/definitions/Contract_Legal" - }, - "type": "array" - }, - "rule": { - "description": "List of Computable Policy Rule Language Representations of this Contract.", - "items": { - "$ref": "#/definitions/Contract_Rule" - }, - "type": "array" - }, - "legallyBindingAttachment": { - "description": "Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.", - "$ref": "#/definitions/Attachment" - }, - "legallyBindingReference": { - "description": "Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Contract_ContentDefinition": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "Detailed Precusory content type.", - "$ref": "#/definitions/CodeableConcept" - }, - "publisher": { - "description": "The individual or organization that published the Contract precursor content.", - "$ref": "#/definitions/Reference" - }, - "publicationDate": { - "description": "The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes.", - "$ref": "#/definitions/dateTime" - }, - "_publicationDate": { - "description": "Extensions for publicationDate", - "$ref": "#/definitions/Element" - }, - "publicationStatus": { - "description": "amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated.", - "$ref": "#/definitions/code" - }, - "_publicationStatus": { - "description": "Extensions for publicationStatus", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "Contract_Term": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for this particular Contract Provision.", - "$ref": "#/definitions/Identifier" - }, - "issued": { - "description": "When this Contract Provision was issued.", - "$ref": "#/definitions/dateTime" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "applies": { - "description": "Relevant time or time-period when this Contract Provision is applicable.", - "$ref": "#/definitions/Period" - }, - "topicCodeableConcept": { - "description": "The entity that the term applies to.", - "$ref": "#/definitions/CodeableConcept" - }, - "topicReference": { - "description": "The entity that the term applies to.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "A legal clause or condition contained within a contract that requires one or both parties to perform a particular requirement by some specified time or prevents one or both parties from performing a particular requirement by some specified time.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "A specialized legal clause or condition based on overarching contract type.", - "$ref": "#/definitions/CodeableConcept" - }, - "text": { - "description": "Statement of a provision in a policy or a contract.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "securityLabel": { - "description": "Security labels that protect the handling of information about the term and its elements, which may be specifically identified..", - "items": { - "$ref": "#/definitions/Contract_SecurityLabel" - }, - "type": "array" - }, - "offer": { - "description": "The matter of concern in the context of this provision of the agrement.", - "$ref": "#/definitions/Contract_Offer" - }, - "asset": { - "description": "Contract Term Asset List.", - "items": { - "$ref": "#/definitions/Contract_Asset" - }, - "type": "array" - }, - "action": { - "description": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", - "items": { - "$ref": "#/definitions/Contract_Action" - }, - "type": "array" - }, - "group": { - "description": "Nested group of Contract Provisions.", - "items": { - "$ref": "#/definitions/Contract_Term" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "offer" - ] - }, - "Contract_SecurityLabel": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "number": { - "description": "Number used to link this term or term element to the applicable Security Label.", - "items": { - "$ref": "#/definitions/unsignedInt" - }, - "type": "array" - }, - "_number": { - "description": "Extensions for number", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "classification": { - "description": "Security label privacy tag that species the level of confidentiality protection required for this term and/or term elements.", - "$ref": "#/definitions/Coding" - }, - "category": { - "description": "Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "control": { - "description": "Security label privacy tag that species the manner in which term and/or term elements are to be protected.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "classification" - ] - }, - "Contract_Offer": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for this particular Contract Provision.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "party": { - "description": "Offer Recipient.", - "items": { - "$ref": "#/definitions/Contract_Party" - }, - "type": "array" - }, - "topic": { - "description": "The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.", - "$ref": "#/definitions/CodeableConcept" - }, - "decision": { - "description": "Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.", - "$ref": "#/definitions/CodeableConcept" - }, - "decisionMode": { - "description": "How the decision about a Contract was conveyed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "answer": { - "description": "Response to offer text.", - "items": { - "$ref": "#/definitions/Contract_Answer" - }, - "type": "array" - }, - "text": { - "description": "Human readable form of this Contract Offer.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "linkId": { - "description": "The id of the clause or question text of the offer in the referenced questionnaire/response.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_linkId": { - "description": "Extensions for linkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "securityLabelNumber": { - "description": "Security labels that protects the offer.", - "items": { - "$ref": "#/definitions/unsignedInt" - }, - "type": "array" - }, - "_securityLabelNumber": { - "description": "Extensions for securityLabelNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Contract_Party": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "Participant in the offer.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "role": { - "description": "How the party participates in the offer.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "reference", - "role" - ] - }, - "Contract_Answer": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "valueBoolean": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueAttachment": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "$ref": "#/definitions/Attachment" - }, - "valueCoding": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "$ref": "#/definitions/Coding" - }, - "valueQuantity": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "$ref": "#/definitions/Quantity" - }, - "valueReference": { - "description": "Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Contract_Asset": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "scope": { - "description": "Differentiates the kind of the asset .", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "Target entity type about which the term may be concerned.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "typeReference": { - "description": "Associated entities.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "subtype": { - "description": "May be a subtype or part of an offered asset.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "relationship": { - "description": "Specifies the applicability of the term to an asset resource instance, and instances it refers to orinstances that refer to it, and/or are owned by the offeree.", - "$ref": "#/definitions/Coding" - }, - "context": { - "description": "Circumstance of the asset.", - "items": { - "$ref": "#/definitions/Contract_Context" - }, - "type": "array" - }, - "condition": { - "description": "Description of the quality and completeness of the asset that imay be a factor in its valuation.", - "$ref": "#/definitions/string" - }, - "_condition": { - "description": "Extensions for condition", - "$ref": "#/definitions/Element" - }, - "periodType": { - "description": "Type of Asset availability for use or ownership.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "period": { - "description": "Asset relevant contractual time period.", - "items": { - "$ref": "#/definitions/Period" - }, - "type": "array" - }, - "usePeriod": { - "description": "Time period of asset use.", - "items": { - "$ref": "#/definitions/Period" - }, - "type": "array" - }, - "text": { - "description": "Clause or question text (Prose Object) concerning the asset in a linked form, such as a QuestionnaireResponse used in the formation of the contract.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "linkId": { - "description": "Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_linkId": { - "description": "Extensions for linkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "answer": { - "description": "Response to assets.", - "items": { - "$ref": "#/definitions/Contract_Answer" - }, - "type": "array" - }, - "securityLabelNumber": { - "description": "Security labels that protects the asset.", - "items": { - "$ref": "#/definitions/unsignedInt" - }, - "type": "array" - }, - "_securityLabelNumber": { - "description": "Extensions for securityLabelNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "valuedItem": { - "description": "Contract Valued Item List.", - "items": { - "$ref": "#/definitions/Contract_ValuedItem" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Contract_Context": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction.", - "$ref": "#/definitions/Reference" - }, - "code": { - "description": "Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "text": { - "description": "Context description.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Contract_ValuedItem": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "entityCodeableConcept": { - "description": "Specific type of Contract Valued Item that may be priced.", - "$ref": "#/definitions/CodeableConcept" - }, - "entityReference": { - "description": "Specific type of Contract Valued Item that may be priced.", - "$ref": "#/definitions/Reference" - }, - "identifier": { - "description": "Identifies a Contract Valued Item instance.", - "$ref": "#/definitions/Identifier" - }, - "effectiveTime": { - "description": "Indicates the time during which this Contract ValuedItem information is effective.", - "$ref": "#/definitions/dateTime" - }, - "_effectiveTime": { - "description": "Extensions for effectiveTime", - "$ref": "#/definitions/Element" - }, - "quantity": { - "description": "Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "A Contract Valued Item unit valuation measure.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "points": { - "description": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.", - "$ref": "#/definitions/decimal" - }, - "_points": { - "description": "Extensions for points", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points \u003d net Amount. Quantity, factor and points are assumed to be 1 if not supplied.", - "$ref": "#/definitions/Money" - }, - "payment": { - "description": "Terms of valuation.", - "$ref": "#/definitions/string" - }, - "_payment": { - "description": "Extensions for payment", - "$ref": "#/definitions/Element" - }, - "paymentDate": { - "description": "When payment is due.", - "$ref": "#/definitions/dateTime" - }, - "_paymentDate": { - "description": "Extensions for paymentDate", - "$ref": "#/definitions/Element" - }, - "responsible": { - "description": "Who will make payment.", - "$ref": "#/definitions/Reference" - }, - "recipient": { - "description": "Who will receive payment.", - "$ref": "#/definitions/Reference" - }, - "linkId": { - "description": "Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_linkId": { - "description": "Extensions for linkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "securityLabelNumber": { - "description": "A set of security labels that define which terms are controlled by this condition.", - "items": { - "$ref": "#/definitions/unsignedInt" - }, - "type": "array" - }, - "_securityLabelNumber": { - "description": "Extensions for securityLabelNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Contract_Action": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "doNotPerform": { - "description": "True if the term prohibits the action.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Entity of the action.", - "items": { - "$ref": "#/definitions/Contract_Subject" - }, - "type": "array" - }, - "intent": { - "description": "Reason or purpose for the action stipulated by this Contract Provision.", - "$ref": "#/definitions/CodeableConcept" - }, - "linkId": { - "description": "Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_linkId": { - "description": "Extensions for linkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "status": { - "description": "Current state of the term action.", - "$ref": "#/definitions/CodeableConcept" - }, - "context": { - "description": "Encounter or Episode with primary association to specified term activity.", - "$ref": "#/definitions/Reference" - }, - "contextLinkId": { - "description": "Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_contextLinkId": { - "description": "Extensions for contextLinkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "occurrenceDateTime": { - "description": "When action happens.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "When action happens.", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "When action happens.", - "$ref": "#/definitions/Timing" - }, - "requester": { - "description": "Who or what initiated the action and has responsibility for its activation.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "requesterLinkId": { - "description": "Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_requesterLinkId": { - "description": "Extensions for requesterLinkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "performerType": { - "description": "The type of individual that is desired or required to perform or not perform the action.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "performerRole": { - "description": "The type of role or competency of an individual desired or required to perform or not perform the action.", - "$ref": "#/definitions/CodeableConcept" - }, - "performer": { - "description": "Indicates who or what is being asked to perform (or not perform) the ction.", - "$ref": "#/definitions/Reference" - }, - "performerLinkId": { - "description": "Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_performerLinkId": { - "description": "Extensions for performerLinkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "reasonCode": { - "description": "Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies permitting or not permitting this action.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "reason": { - "description": "Describes why the action is to be performed or not performed in textual form.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_reason": { - "description": "Extensions for reason", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "reasonLinkId": { - "description": "Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_reasonLinkId": { - "description": "Extensions for reasonLinkId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "note": { - "description": "Comments made about the term action made by the requester, performer, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "securityLabelNumber": { - "description": "Security labels that protects the action.", - "items": { - "$ref": "#/definitions/unsignedInt" - }, - "type": "array" - }, - "_securityLabelNumber": { - "description": "Extensions for securityLabelNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type", - "intent", - "status" - ] - }, - "Contract_Subject": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "The entity the action is performed or not performed on or for.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "role": { - "description": "Role type of agent assigned roles in this Contract.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "reference" - ] - }, - "Contract_Signer": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Role of this Contract signer, e.g. notary, grantee.", - "$ref": "#/definitions/Coding" - }, - "party": { - "description": "Party which is a signator to this Contract.", - "$ref": "#/definitions/Reference" - }, - "signature": { - "description": "Legally binding Contract DSIG signature contents in Base64.", - "items": { - "$ref": "#/definitions/Signature" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "signature", - "type", - "party" - ] - }, - "Contract_Friendly": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentAttachment": { - "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.", - "$ref": "#/definitions/Attachment" - }, - "contentReference": { - "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Contract_Legal": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentAttachment": { - "description": "Contract legal text in human renderable form.", - "$ref": "#/definitions/Attachment" - }, - "contentReference": { - "description": "Contract legal text in human renderable form.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Contract_Rule": { - "description": "Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "contentAttachment": { - "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).", - "$ref": "#/definitions/Attachment" - }, - "contentReference": { - "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Coverage": { - "description": "Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.", - "properties": { - "resourceType": { - "description": "This is a Coverage resource", - "const": "Coverage" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this coverage.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.", - "$ref": "#/definitions/CodeableConcept" - }, - "policyHolder": { - "description": "The party who \u0027owns\u0027 the insurance policy.", - "$ref": "#/definitions/Reference" - }, - "subscriber": { - "description": "The party who has signed-up for or \u0027owns\u0027 the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.", - "$ref": "#/definitions/Reference" - }, - "subscriberId": { - "description": "The insurer assigned ID for the Subscriber.", - "$ref": "#/definitions/string" - }, - "_subscriberId": { - "description": "Extensions for subscriberId", - "$ref": "#/definitions/Element" - }, - "beneficiary": { - "description": "The party who benefits from the insurance coverage; the patient when products and/or services are provided.", - "$ref": "#/definitions/Reference" - }, - "dependent": { - "description": "A unique identifier for a dependent under the coverage.", - "$ref": "#/definitions/string" - }, - "_dependent": { - "description": "Extensions for dependent", - "$ref": "#/definitions/Element" - }, - "relationship": { - "description": "The relationship of beneficiary (patient) to the subscriber.", - "$ref": "#/definitions/CodeableConcept" - }, - "period": { - "description": "Time period during which the coverage is in force. A missing start date indicates the start date isn\u0027t known, a missing end date means the coverage is continuing to be in force.", - "$ref": "#/definitions/Period" - }, - "payor": { - "description": "The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "class": { - "description": "A suite of underwriter specific classifiers.", - "items": { - "$ref": "#/definitions/Coverage_Class" - }, - "type": "array" - }, - "order": { - "description": "The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.", - "$ref": "#/definitions/positiveInt" - }, - "_order": { - "description": "Extensions for order", - "$ref": "#/definitions/Element" - }, - "network": { - "description": "The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the \u0027in-network\u0027 rate, otherwise \u0027out of network\u0027 terms and conditions apply.", - "$ref": "#/definitions/string" - }, - "_network": { - "description": "Extensions for network", - "$ref": "#/definitions/Element" - }, - "costToBeneficiary": { - "description": "A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.", - "items": { - "$ref": "#/definitions/Coverage_CostToBeneficiary" - }, - "type": "array" - }, - "subrogation": { - "description": "When \u0027subrogation\u003dtrue\u0027 this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.", - "$ref": "#/definitions/boolean" - }, - "_subrogation": { - "description": "Extensions for subrogation", - "$ref": "#/definitions/Element" - }, - "contract": { - "description": "The policy(s) which constitute this insurance coverage.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "payor", - "beneficiary", - "resourceType" - ] - }, - "Coverage_Class": { - "description": "Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "The alphanumeric string value associated with the insurer issued label.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A short description for the class.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "Coverage_CostToBeneficiary": { - "description": "Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The category of patient centric costs associated with treatment.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "The amount due from the patient for the cost category.", - "$ref": "#/definitions/Quantity" - }, - "valueMoney": { - "description": "The amount due from the patient for the cost category.", - "$ref": "#/definitions/Money" - }, - "exception": { - "description": "A suite of codes indicating exceptions or reductions to patient costs and their effective periods.", - "items": { - "$ref": "#/definitions/Coverage_Exception" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Coverage_Exception": { - "description": "Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The code for the specific exception.", - "$ref": "#/definitions/CodeableConcept" - }, - "period": { - "description": "The timeframe during when the exception is in force.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "CoverageEligibilityRequest": { - "description": "The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.", - "properties": { - "resourceType": { - "description": "This is a CoverageEligibilityRequest resource", - "const": "CoverageEligibilityRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this coverage eligiblity request.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "When the requestor expects the processor to complete processing.", - "$ref": "#/definitions/CodeableConcept" - }, - "purpose": { - "description": "Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or \u0027now\u0027 if not specified.", - "items": { - "enum": [ - "auth-requirements", - "benefits", - "discovery", - "validation" - ] - }, - "type": "array" - }, - "_purpose": { - "description": "Extensions for purpose", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "patient": { - "description": "The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.", - "$ref": "#/definitions/Reference" - }, - "servicedDate": { - "description": "The date or dates when the enclosed suite of services were performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the enclosed suite of services were performed or completed.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "The date when this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "enterer": { - "description": "Person who created the request.", - "$ref": "#/definitions/Reference" - }, - "provider": { - "description": "The provider which is responsible for the request.", - "$ref": "#/definitions/Reference" - }, - "insurer": { - "description": "The Insurer who issued the coverage in question and is the recipient of the request.", - "$ref": "#/definitions/Reference" - }, - "facility": { - "description": "Facility where the services are intended to be provided.", - "$ref": "#/definitions/Reference" - }, - "supportingInfo": { - "description": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.", - "items": { - "$ref": "#/definitions/CoverageEligibilityRequest_SupportingInfo" - }, - "type": "array" - }, - "insurance": { - "description": "Financial instruments for reimbursement for the health care products and services.", - "items": { - "$ref": "#/definitions/CoverageEligibilityRequest_Insurance" - }, - "type": "array" - }, - "item": { - "description": "Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.", - "items": { - "$ref": "#/definitions/CoverageEligibilityRequest_Item" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "insurer", - "resourceType" - ] - }, - "CoverageEligibilityRequest_SupportingInfo": { - "description": "The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify supporting information entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "information": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Reference" - }, - "appliesToAll": { - "description": "The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.", - "$ref": "#/definitions/boolean" - }, - "_appliesToAll": { - "description": "Extensions for appliesToAll", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "information" - ] - }, - "CoverageEligibilityRequest_Insurance": { - "description": "The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "focal": { - "description": "A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.", - "$ref": "#/definitions/boolean" - }, - "_focal": { - "description": "Extensions for focal", - "$ref": "#/definitions/Element" - }, - "coverage": { - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.", - "$ref": "#/definitions/Reference" - }, - "businessArrangement": { - "description": "A business agreement number established between the provider and the insurer for special business processing purposes.", - "$ref": "#/definitions/string" - }, - "_businessArrangement": { - "description": "Extensions for businessArrangement", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "CoverageEligibilityRequest_Item": { - "description": "The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "supportingInfoSequence": { - "description": "Exceptions, special conditions and supporting information applicable for this service or product line.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_supportingInfoSequence": { - "description": "Extensions for supportingInfoSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "This contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "provider": { - "description": "The practitioner who is responsible for the product or service to be rendered to the patient.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "The amount charged to the patient by the provider for a single unit.", - "$ref": "#/definitions/Money" - }, - "facility": { - "description": "Facility where the services will be provided.", - "$ref": "#/definitions/Reference" - }, - "diagnosis": { - "description": "Patient diagnosis for which care is sought.", - "items": { - "$ref": "#/definitions/CoverageEligibilityRequest_Diagnosis" - }, - "type": "array" - }, - "detail": { - "description": "The plan/proposal/order describing the proposed service in detail.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "CoverageEligibilityRequest_Diagnosis": { - "description": "The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "diagnosisCodeableConcept": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/CodeableConcept" - }, - "diagnosisReference": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "CoverageEligibilityResponse": { - "description": "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.", - "properties": { - "resourceType": { - "description": "This is a CoverageEligibilityResponse resource", - "const": "CoverageEligibilityResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this coverage eligiblity request.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "purpose": { - "description": "Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or \u0027now\u0027 if not specified.", - "items": { - "enum": [ - "auth-requirements", - "benefits", - "discovery", - "validation" - ] - }, - "type": "array" - }, - "_purpose": { - "description": "Extensions for purpose", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "patient": { - "description": "The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.", - "$ref": "#/definitions/Reference" - }, - "servicedDate": { - "description": "The date or dates when the enclosed suite of services were performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the enclosed suite of services were performed or completed.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "The date this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "requestor": { - "description": "The provider which is responsible for the request.", - "$ref": "#/definitions/Reference" - }, - "request": { - "description": "Reference to the original request resource.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "The outcome of the request processing.", - "enum": [ - "queued", - "complete", - "error", - "partial" - ] - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "disposition": { - "description": "A human readable description of the status of the adjudication.", - "$ref": "#/definitions/string" - }, - "_disposition": { - "description": "Extensions for disposition", - "$ref": "#/definitions/Element" - }, - "insurer": { - "description": "The Insurer who issued the coverage in question and is the author of the response.", - "$ref": "#/definitions/Reference" - }, - "insurance": { - "description": "Financial instruments for reimbursement for the health care products and services.", - "items": { - "$ref": "#/definitions/CoverageEligibilityResponse_Insurance" - }, - "type": "array" - }, - "preAuthRef": { - "description": "A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.", - "$ref": "#/definitions/string" - }, - "_preAuthRef": { - "description": "Extensions for preAuthRef", - "$ref": "#/definitions/Element" - }, - "form": { - "description": "A code for the form to be used for printing the content.", - "$ref": "#/definitions/CodeableConcept" - }, - "error": { - "description": "Errors encountered during the processing of the request.", - "items": { - "$ref": "#/definitions/CoverageEligibilityResponse_Error" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "request", - "patient", - "insurer", - "resourceType" - ] - }, - "CoverageEligibilityResponse_Insurance": { - "description": "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "coverage": { - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.", - "$ref": "#/definitions/Reference" - }, - "inforce": { - "description": "Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.", - "$ref": "#/definitions/boolean" - }, - "_inforce": { - "description": "Extensions for inforce", - "$ref": "#/definitions/Element" - }, - "benefitPeriod": { - "description": "The term of the benefits documented in this response.", - "$ref": "#/definitions/Period" - }, - "item": { - "description": "Benefits and optionally current balances, and authorization details by category or service.", - "items": { - "$ref": "#/definitions/CoverageEligibilityResponse_Item" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "CoverageEligibilityResponse_Item": { - "description": "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "This contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "provider": { - "description": "The practitioner who is eligible for the provision of the product or service.", - "$ref": "#/definitions/Reference" - }, - "excluded": { - "description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.", - "$ref": "#/definitions/boolean" - }, - "_excluded": { - "description": "Extensions for excluded", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A short name or tag for the benefit.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A richer description of the benefit or services covered.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "network": { - "description": "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.", - "$ref": "#/definitions/CodeableConcept" - }, - "unit": { - "description": "Indicates if the benefits apply to an individual or to the family.", - "$ref": "#/definitions/CodeableConcept" - }, - "term": { - "description": "The term or period of the values such as \u0027maximum lifetime benefit\u0027 or \u0027maximum annual visits\u0027.", - "$ref": "#/definitions/CodeableConcept" - }, - "benefit": { - "description": "Benefits used to date.", - "items": { - "$ref": "#/definitions/CoverageEligibilityResponse_Benefit" - }, - "type": "array" - }, - "authorizationRequired": { - "description": "A boolean flag indicating whether a preauthorization is required prior to actual service delivery.", - "$ref": "#/definitions/boolean" - }, - "_authorizationRequired": { - "description": "Extensions for authorizationRequired", - "$ref": "#/definitions/Element" - }, - "authorizationSupporting": { - "description": "Codes or comments regarding information or actions associated with the preauthorization.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "authorizationUrl": { - "description": "A web location for obtaining requirements or descriptive information regarding the preauthorization.", - "$ref": "#/definitions/uri" - }, - "_authorizationUrl": { - "description": "Extensions for authorizationUrl", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "CoverageEligibilityResponse_Benefit": { - "description": "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Classification of benefit being provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "allowedUnsignedInt": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_allowedUnsignedInt": { - "description": "Extensions for allowedUnsignedInt", - "$ref": "#/definitions/Element" - }, - "allowedString": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_allowedString": { - "description": "Extensions for allowedString", - "$ref": "#/definitions/Element" - }, - "allowedMoney": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "$ref": "#/definitions/Money" - }, - "usedUnsignedInt": { - "description": "The quantity of the benefit which have been consumed to date.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_usedUnsignedInt": { - "description": "Extensions for usedUnsignedInt", - "$ref": "#/definitions/Element" - }, - "usedString": { - "description": "The quantity of the benefit which have been consumed to date.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_usedString": { - "description": "Extensions for usedString", - "$ref": "#/definitions/Element" - }, - "usedMoney": { - "description": "The quantity of the benefit which have been consumed to date.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "CoverageEligibilityResponse_Error": { - "description": "This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "An error code,from a specified code system, which details why the eligibility check could not be performed.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "DetectedIssue": { - "description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.", - "properties": { - "resourceType": { - "description": "This is a DetectedIssue resource", - "const": "DetectedIssue" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifier associated with the detected issue record.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the status of the detected issue.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Identifies the general type of issue identified.", - "$ref": "#/definitions/CodeableConcept" - }, - "severity": { - "description": "Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.", - "enum": [ - "high", - "moderate", - "low" - ] - }, - "_severity": { - "description": "Extensions for severity", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "Indicates the patient whose record the detected issue is associated with.", - "$ref": "#/definitions/Reference" - }, - "identifiedDateTime": { - "description": "The date or period when the detected issue was initially identified.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_identifiedDateTime": { - "description": "Extensions for identifiedDateTime", - "$ref": "#/definitions/Element" - }, - "identifiedPeriod": { - "description": "The date or period when the detected issue was initially identified.", - "$ref": "#/definitions/Period" - }, - "author": { - "description": "Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.", - "$ref": "#/definitions/Reference" - }, - "implicated": { - "description": "Indicates the resource representing the current activity or proposed activity that is potentially problematic.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "evidence": { - "description": "Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.", - "items": { - "$ref": "#/definitions/DetectedIssue_Evidence" - }, - "type": "array" - }, - "detail": { - "description": "A textual explanation of the detected issue.", - "$ref": "#/definitions/string" - }, - "_detail": { - "description": "Extensions for detail", - "$ref": "#/definitions/Element" - }, - "reference": { - "description": "The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.", - "$ref": "#/definitions/uri" - }, - "_reference": { - "description": "Extensions for reference", - "$ref": "#/definitions/Element" - }, - "mitigation": { - "description": "Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.", - "items": { - "$ref": "#/definitions/DetectedIssue_Mitigation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "DetectedIssue_Evidence": { - "description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A manifestation that led to the recording of this detected issue.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "detail": { - "description": "Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "DetectedIssue_Mitigation": { - "description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "Indicates when the mitigating action was documented.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "Device": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "resourceType": { - "description": "This is a Device resource", - "const": "Device" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique instance identifiers assigned to a device by manufacturers other organizations or owners.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "definition": { - "description": "The reference to the definition for the device.", - "$ref": "#/definitions/Reference" - }, - "udiCarrier": { - "description": "Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.", - "items": { - "$ref": "#/definitions/Device_UdiCarrier" - }, - "type": "array" - }, - "status": { - "description": "Status of the Device availability.", - "enum": [ - "active", - "inactive", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Reason for the dtatus of the Device availability.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "distinctIdentifier": { - "description": "The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.", - "$ref": "#/definitions/string" - }, - "_distinctIdentifier": { - "description": "Extensions for distinctIdentifier", - "$ref": "#/definitions/Element" - }, - "manufacturer": { - "description": "A name of the manufacturer.", - "$ref": "#/definitions/string" - }, - "_manufacturer": { - "description": "Extensions for manufacturer", - "$ref": "#/definitions/Element" - }, - "manufactureDate": { - "description": "The date and time when the device was manufactured.", - "$ref": "#/definitions/dateTime" - }, - "_manufactureDate": { - "description": "Extensions for manufactureDate", - "$ref": "#/definitions/Element" - }, - "expirationDate": { - "description": "The date and time beyond which this device is no longer valid or should not be used (if applicable).", - "$ref": "#/definitions/dateTime" - }, - "_expirationDate": { - "description": "Extensions for expirationDate", - "$ref": "#/definitions/Element" - }, - "lotNumber": { - "description": "Lot number assigned by the manufacturer.", - "$ref": "#/definitions/string" - }, - "_lotNumber": { - "description": "Extensions for lotNumber", - "$ref": "#/definitions/Element" - }, - "serialNumber": { - "description": "The serial number assigned by the organization when the device was manufactured.", - "$ref": "#/definitions/string" - }, - "_serialNumber": { - "description": "Extensions for serialNumber", - "$ref": "#/definitions/Element" - }, - "deviceName": { - "description": "This represents the manufacturer\u0027s name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.", - "items": { - "$ref": "#/definitions/Device_DeviceName" - }, - "type": "array" - }, - "modelNumber": { - "description": "The model number for the device.", - "$ref": "#/definitions/string" - }, - "_modelNumber": { - "description": "Extensions for modelNumber", - "$ref": "#/definitions/Element" - }, - "partNumber": { - "description": "The part number of the device.", - "$ref": "#/definitions/string" - }, - "_partNumber": { - "description": "Extensions for partNumber", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind or type of device.", - "$ref": "#/definitions/CodeableConcept" - }, - "specialization": { - "description": "The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.", - "items": { - "$ref": "#/definitions/Device_Specialization" - }, - "type": "array" - }, - "version": { - "description": "The actual design of the device or software version running on the device.", - "items": { - "$ref": "#/definitions/Device_Version" - }, - "type": "array" - }, - "property": { - "description": "The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.", - "items": { - "$ref": "#/definitions/Device_Property" - }, - "type": "array" - }, - "patient": { - "description": "Patient information, If the device is affixed to a person.", - "$ref": "#/definitions/Reference" - }, - "owner": { - "description": "An organization that is responsible for the provision and ongoing maintenance of the device.", - "$ref": "#/definitions/Reference" - }, - "contact": { - "description": "Contact details for an organization or a particular human that is responsible for the device.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "location": { - "description": "The place where the device can be found.", - "$ref": "#/definitions/Reference" - }, - "url": { - "description": "A network address on which the device may be contacted directly.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Descriptive information, usage information or implantation information that is not captured in an existing element.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "safety": { - "description": "Provides additional safety characteristics about a medical device. For example devices containing latex.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "parent": { - "description": "The parent device.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Device_UdiCarrier": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "deviceIdentifier": { - "description": "The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.", - "$ref": "#/definitions/string" - }, - "_deviceIdentifier": { - "description": "Extensions for deviceIdentifier", - "$ref": "#/definitions/Element" - }, - "issuer": { - "description": "Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :\n1) GS1: \nhttp://hl7.org/fhir/NamingSystem/gs1-di, \n2) HIBCC:\nhttp://hl7.org/fhir/NamingSystem/hibcc-dI, \n3) ICCBBA for blood containers:\nhttp://hl7.org/fhir/NamingSystem/iccbba-blood-di, \n4) ICCBA for other devices:\nhttp://hl7.org/fhir/NamingSystem/iccbba-other-di.", - "$ref": "#/definitions/uri" - }, - "_issuer": { - "description": "Extensions for issuer", - "$ref": "#/definitions/Element" - }, - "jurisdiction": { - "description": "The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.", - "$ref": "#/definitions/uri" - }, - "_jurisdiction": { - "description": "Extensions for jurisdiction", - "$ref": "#/definitions/Element" - }, - "carrierAIDC": { - "description": "The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.", - "$ref": "#/definitions/base64Binary" - }, - "_carrierAIDC": { - "description": "Extensions for carrierAIDC", - "$ref": "#/definitions/Element" - }, - "carrierHRF": { - "description": "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.", - "$ref": "#/definitions/string" - }, - "_carrierHRF": { - "description": "Extensions for carrierHRF", - "$ref": "#/definitions/Element" - }, - "entryType": { - "description": "A coded entry to indicate how the data was entered.", - "enum": [ - "barcode", - "rfid", - "manual", - "card", - "self-reported", - "unknown" - ] - }, - "_entryType": { - "description": "Extensions for entryType", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Device_DeviceName": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the device.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.", - "enum": [ - "udi-label-name", - "user-friendly-name", - "patient-reported-name", - "manufacturer-name", - "model-name", - "other" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Device_Specialization": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "systemType": { - "description": "The standard that is used to operate and communicate.", - "$ref": "#/definitions/CodeableConcept" - }, - "version": { - "description": "The version of the standard that is used to operate and communicate.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "systemType" - ] - }, - "Device_Version": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of the device version.", - "$ref": "#/definitions/CodeableConcept" - }, - "component": { - "description": "A single component of the device version.", - "$ref": "#/definitions/Identifier" - }, - "value": { - "description": "The version text.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Device_Property": { - "description": "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Code that specifies the property DeviceDefinitionPropetyCode (Extensible).", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "Property value as a quantity.", - "items": { - "$ref": "#/definitions/Quantity" - }, - "type": "array" - }, - "valueCode": { - "description": "Property value as a code, e.g., NTP4 (synced to NTP).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "DeviceDefinition": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "resourceType": { - "description": "This is a DeviceDefinition resource", - "const": "DeviceDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "udiDeviceIdentifier": { - "description": "Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.", - "items": { - "$ref": "#/definitions/DeviceDefinition_UdiDeviceIdentifier" - }, - "type": "array" - }, - "manufacturerString": { - "description": "A name of the manufacturer.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_manufacturerString": { - "description": "Extensions for manufacturerString", - "$ref": "#/definitions/Element" - }, - "manufacturerReference": { - "description": "A name of the manufacturer.", - "$ref": "#/definitions/Reference" - }, - "deviceName": { - "description": "A name given to the device to identify it.", - "items": { - "$ref": "#/definitions/DeviceDefinition_DeviceName" - }, - "type": "array" - }, - "modelNumber": { - "description": "The model number for the device.", - "$ref": "#/definitions/string" - }, - "_modelNumber": { - "description": "Extensions for modelNumber", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "What kind of device or device system this is.", - "$ref": "#/definitions/CodeableConcept" - }, - "specialization": { - "description": "The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.", - "items": { - "$ref": "#/definitions/DeviceDefinition_Specialization" - }, - "type": "array" - }, - "version": { - "description": "The available versions of the device, e.g., software versions.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_version": { - "description": "Extensions for version", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "safety": { - "description": "Safety characteristics of the device.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "shelfLifeStorage": { - "description": "Shelf Life and storage information.", - "items": { - "$ref": "#/definitions/ProductShelfLife" - }, - "type": "array" - }, - "physicalCharacteristics": { - "description": "Dimensions, color etc.", - "$ref": "#/definitions/ProdCharacteristic" - }, - "languageCode": { - "description": "Language code for the human-readable text strings produced by the device (all supported).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "capability": { - "description": "Device capabilities.", - "items": { - "$ref": "#/definitions/DeviceDefinition_Capability" - }, - "type": "array" - }, - "property": { - "description": "The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.", - "items": { - "$ref": "#/definitions/DeviceDefinition_Property" - }, - "type": "array" - }, - "owner": { - "description": "An organization that is responsible for the provision and ongoing maintenance of the device.", - "$ref": "#/definitions/Reference" - }, - "contact": { - "description": "Contact details for an organization or a particular human that is responsible for the device.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "url": { - "description": "A network address on which the device may be contacted directly.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "onlineInformation": { - "description": "Access to on-line information about the device.", - "$ref": "#/definitions/uri" - }, - "_onlineInformation": { - "description": "Extensions for onlineInformation", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Descriptive information, usage information or implantation information that is not captured in an existing element.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "quantity": { - "description": "The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).", - "$ref": "#/definitions/Quantity" - }, - "parentDevice": { - "description": "The parent device it can be part of.", - "$ref": "#/definitions/Reference" - }, - "material": { - "description": "A substance used to create the material(s) of which the device is made.", - "items": { - "$ref": "#/definitions/DeviceDefinition_Material" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "DeviceDefinition_UdiDeviceIdentifier": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "deviceIdentifier": { - "description": "The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.", - "$ref": "#/definitions/string" - }, - "_deviceIdentifier": { - "description": "Extensions for deviceIdentifier", - "$ref": "#/definitions/Element" - }, - "issuer": { - "description": "The organization that assigns the identifier algorithm.", - "$ref": "#/definitions/uri" - }, - "_issuer": { - "description": "Extensions for issuer", - "$ref": "#/definitions/Element" - }, - "jurisdiction": { - "description": "The jurisdiction to which the deviceIdentifier applies.", - "$ref": "#/definitions/uri" - }, - "_jurisdiction": { - "description": "Extensions for jurisdiction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "DeviceDefinition_DeviceName": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the device.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.", - "enum": [ - "udi-label-name", - "user-friendly-name", - "patient-reported-name", - "manufacturer-name", - "model-name", - "other" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "DeviceDefinition_Specialization": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "systemType": { - "description": "The standard that is used to operate and communicate.", - "$ref": "#/definitions/string" - }, - "_systemType": { - "description": "Extensions for systemType", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version of the standard that is used to operate and communicate.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "DeviceDefinition_Capability": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of capability.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "Description of capability.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "DeviceDefinition_Property": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Code that specifies the property DeviceDefinitionPropetyCode (Extensible).", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "Property value as a quantity.", - "items": { - "$ref": "#/definitions/Quantity" - }, - "type": "array" - }, - "valueCode": { - "description": "Property value as a code, e.g., NTP4 (synced to NTP).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "DeviceDefinition_Material": { - "description": "The characteristics, operational status and capabilities of a medical-related component of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "substance": { - "description": "The substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "alternate": { - "description": "Indicates an alternative material of the device.", - "$ref": "#/definitions/boolean" - }, - "_alternate": { - "description": "Extensions for alternate", - "$ref": "#/definitions/Element" - }, - "allergenicIndicator": { - "description": "Whether the substance is a known or suspected allergen.", - "$ref": "#/definitions/boolean" - }, - "_allergenicIndicator": { - "description": "Extensions for allergenicIndicator", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "substance" - ] - }, - "DeviceMetric": { - "description": "Describes a measurement, calculation or setting capability of a medical device.", - "properties": { - "resourceType": { - "description": "This is a DeviceMetric resource", - "const": "DeviceMetric" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "unit": { - "description": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.", - "$ref": "#/definitions/Reference" - }, - "parent": { - "description": "Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.", - "$ref": "#/definitions/Reference" - }, - "operationalStatus": { - "description": "Indicates current operational state of the device. For example: On, Off, Standby, etc.", - "enum": [ - "on", - "off", - "standby", - "entered-in-error" - ] - }, - "_operationalStatus": { - "description": "Extensions for operationalStatus", - "$ref": "#/definitions/Element" - }, - "color": { - "description": "Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.", - "enum": [ - "black", - "red", - "green", - "yellow", - "blue", - "magenta", - "cyan", - "white" - ] - }, - "_color": { - "description": "Extensions for color", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.", - "enum": [ - "measurement", - "setting", - "calculation", - "unspecified" - ] - }, - "_category": { - "description": "Extensions for category", - "$ref": "#/definitions/Element" - }, - "measurementPeriod": { - "description": "Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.", - "$ref": "#/definitions/Timing" - }, - "calibration": { - "description": "Describes the calibrations that have been performed or that are required to be performed.", - "items": { - "$ref": "#/definitions/DeviceMetric_Calibration" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type", - "resourceType" - ] - }, - "DeviceMetric_Calibration": { - "description": "Describes a measurement, calculation or setting capability of a medical device.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Describes the type of the calibration method.", - "enum": [ - "unspecified", - "offset", - "gain", - "two-point" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "state": { - "description": "Describes the state of the calibration.", - "enum": [ - "not-calibrated", - "calibration-required", - "calibrated", - "unspecified" - ] - }, - "_state": { - "description": "Extensions for state", - "$ref": "#/definitions/Element" - }, - "time": { - "description": "Describes the time last calibration has been performed.", - "$ref": "#/definitions/instant" - }, - "_time": { - "description": "Extensions for time", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "DeviceRequest": { - "description": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.", - "properties": { - "resourceType": { - "description": "This is a DeviceRequest resource", - "const": "DeviceRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this order by the orderer or by the receiver.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "Plan/proposal/order fulfilled by this request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "priorRequest": { - "description": "The request takes the place of the referenced completed or terminated request(s).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "groupIdentifier": { - "description": "Composite request this is part of.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The status of the request.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "intent": { - "description": "Whether the request is a proposal, plan, an original order or a reflex order.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the {{title}} should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "codeReference": { - "description": "The details of the device to be used.", - "$ref": "#/definitions/Reference" - }, - "codeCodeableConcept": { - "description": "The details of the device to be used.", - "$ref": "#/definitions/CodeableConcept" - }, - "parameter": { - "description": "Specific parameters for the ordered item. For example, the prism value for lenses.", - "items": { - "$ref": "#/definitions/DeviceRequest_Parameter" - }, - "type": "array" - }, - "subject": { - "description": "The patient who will use the device.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "An encounter that provides additional context in which this request is made.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".", - "$ref": "#/definitions/Timing" - }, - "authoredOn": { - "description": "When the request transitioned to being actionable.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The individual who initiated the request and has responsibility for its activation.", - "$ref": "#/definitions/Reference" - }, - "performerType": { - "description": "Desired type of performer for doing the diagnostic testing.", - "$ref": "#/definitions/CodeableConcept" - }, - "performer": { - "description": "The desired performer for doing the diagnostic testing.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Reason or justification for the use of this device.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Reason or justification for the use of this device.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "insurance": { - "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject\u0027s body the device will be used (i.e. the target site).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "relevantHistory": { - "description": "Key events in the history of the request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "DeviceRequest_Parameter": { - "description": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code or string that identifies the device detail being asserted.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCodeableConcept": { - "description": "The value of the device detail.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "The value of the device detail.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The value of the device detail.", - "$ref": "#/definitions/Range" - }, - "valueBoolean": { - "description": "The value of the device detail.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "DeviceUseStatement": { - "description": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.", - "properties": { - "resourceType": { - "description": "This is a DeviceUseStatement resource", - "const": "DeviceUseStatement" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An external identifier for this statement such as an IRI.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "A code representing the patient or other source\u0027s judgment about the state of the device used that this statement is about. Generally this will be active or completed.", - "enum": [ - "active", - "completed", - "entered-in-error", - "intended", - "stopped", - "on-hold" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "The patient who used the device.", - "$ref": "#/definitions/Reference" - }, - "derivedFrom": { - "description": "Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "timingTiming": { - "description": "How often the device was used.", - "$ref": "#/definitions/Timing" - }, - "timingPeriod": { - "description": "How often the device was used.", - "$ref": "#/definitions/Period" - }, - "timingDateTime": { - "description": "How often the device was used.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timingDateTime": { - "description": "Extensions for timingDateTime", - "$ref": "#/definitions/Element" - }, - "recordedOn": { - "description": "The time at which the statement was made/recorded.", - "$ref": "#/definitions/dateTime" - }, - "_recordedOn": { - "description": "Extensions for recordedOn", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "Who reported the device was being used by the patient.", - "$ref": "#/definitions/Reference" - }, - "device": { - "description": "The details of the device used.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Reason or justification for the use of the device.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies this DeviceUseStatement.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "Indicates the anotomic location on the subject\u0027s body where the device was used ( i.e. the target).", - "$ref": "#/definitions/CodeableConcept" - }, - "note": { - "description": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "device", - "resourceType" - ] - }, - "DiagnosticReport": { - "description": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.", - "properties": { - "resourceType": { - "description": "This is a DiagnosticReport resource", - "const": "DiagnosticReport" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this report by the performer or other systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "Details concerning a service requested.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The status of the diagnostic report.", - "enum": [ - "registered", - "partial", - "preliminary", - "final", - "amended", - "corrected", - "appended", - "cancelled", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "code": { - "description": "A code or name that describes this diagnostic report.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", - "$ref": "#/definitions/Reference" - }, - "effectiveDateTime": { - "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_effectiveDateTime": { - "description": "Extensions for effectiveDateTime", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", - "$ref": "#/definitions/Period" - }, - "issued": { - "description": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", - "$ref": "#/definitions/instant" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "performer": { - "description": "The diagnostic service that is responsible for issuing the report.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "resultsInterpreter": { - "description": "The practitioner or organization that is responsible for the report\u0027s conclusions and interpretations.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "specimen": { - "description": "Details about the specimens on which this diagnostic report is based.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "result": { - "description": "[Observations](observation.html) that are part of this diagnostic report.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "imagingStudy": { - "description": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "media": { - "description": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", - "items": { - "$ref": "#/definitions/DiagnosticReport_Media" - }, - "type": "array" - }, - "conclusion": { - "description": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", - "$ref": "#/definitions/string" - }, - "_conclusion": { - "description": "Extensions for conclusion", - "$ref": "#/definitions/Element" - }, - "conclusionCode": { - "description": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "presentedForm": { - "description": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code", - "resourceType" - ] - }, - "DiagnosticReport_Media": { - "description": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "comment": { - "description": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer\u0027s attention to important features.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "link": { - "description": "Reference to the image source.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "link" - ] - }, - "DocumentManifest": { - "description": "A collection of documents compiled for a purpose together with metadata that applies to the collection.", - "properties": { - "resourceType": { - "description": "This is a DocumentManifest resource", - "const": "DocumentManifest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "masterIdentifier": { - "description": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.", - "$ref": "#/definitions/Identifier" - }, - "identifier": { - "description": "Other identifiers associated with the document manifest, including version independent identifiers.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of this document manifest.", - "enum": [ - "current", - "superseded", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).", - "$ref": "#/definitions/Reference" - }, - "created": { - "description": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "recipient": { - "description": "A patient, practitioner, or organization for which this set of documents is intended.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "source": { - "description": "Identifies the source system, application, or software that produced the document manifest.", - "$ref": "#/definitions/uri" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Human-readable description of the source document. This is sometimes known as the \"title\".", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "content": { - "description": "The list of Resources that consist of the parts of this manifest.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "related": { - "description": "Related identifiers or resources associated with the DocumentManifest.", - "items": { - "$ref": "#/definitions/DocumentManifest_Related" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "content", - "resourceType" - ] - }, - "DocumentManifest_Related": { - "description": "A collection of documents compiled for a purpose together with metadata that applies to the collection.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.", - "$ref": "#/definitions/Identifier" - }, - "ref": { - "description": "Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "DocumentReference": { - "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.", - "properties": { - "resourceType": { - "description": "This is a DocumentReference resource", - "const": "DocumentReference" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "masterIdentifier": { - "description": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.", - "$ref": "#/definitions/Identifier" - }, - "identifier": { - "description": "Other identifiers associated with the document, including version independent identifiers.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of this document reference.", - "enum": [ - "current", - "superseded", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "docStatus": { - "description": "The status of the underlying document.", - "$ref": "#/definitions/code" - }, - "_docStatus": { - "description": "Extensions for docStatus", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "subject": { - "description": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "When the document reference was created.", - "$ref": "#/definitions/instant" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Identifies who is responsible for adding the information to the document.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "authenticator": { - "description": "Which person or organization authenticates that this document is valid.", - "$ref": "#/definitions/Reference" - }, - "custodian": { - "description": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.", - "$ref": "#/definitions/Reference" - }, - "relatesTo": { - "description": "Relationships that this document has with other document references that already exist.", - "items": { - "$ref": "#/definitions/DocumentReference_RelatesTo" - }, - "type": "array" - }, - "description": { - "description": "Human-readable description of the source document.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "securityLabel": { - "description": "A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "content": { - "description": "The document and format referenced. There may be multiple content element repetitions, each with a different format.", - "items": { - "$ref": "#/definitions/DocumentReference_Content" - }, - "type": "array" - }, - "context": { - "description": "The clinical context in which the document was prepared.", - "$ref": "#/definitions/DocumentReference_Context" - } - }, - "additionalProperties": false, - "required": [ - "content", - "resourceType" - ] - }, - "DocumentReference_RelatesTo": { - "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The type of relationship that this document has with anther document.", - "enum": [ - "replaces", - "transforms", - "signs", - "appends" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "The target document of this relationship.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "target" - ] - }, - "DocumentReference_Content": { - "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "attachment": { - "description": "The document or URL of the document along with critical metadata to prove content has integrity.", - "$ref": "#/definitions/Attachment" - }, - "format": { - "description": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.", - "$ref": "#/definitions/Coding" - } - }, - "additionalProperties": false, - "required": [ - "attachment" - ] - }, - "DocumentReference_Context": { - "description": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "encounter": { - "description": "Describes the clinical encounter or type of care that the document content is associated with.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "event": { - "description": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "period": { - "description": "The time period over which the service that is described by the document was provided.", - "$ref": "#/definitions/Period" - }, - "facilityType": { - "description": "The kind of facility where the patient was seen.", - "$ref": "#/definitions/CodeableConcept" - }, - "practiceSetting": { - "description": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", - "$ref": "#/definitions/CodeableConcept" - }, - "sourcePatientInfo": { - "description": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.", - "$ref": "#/definitions/Reference" - }, - "related": { - "description": "Related identifiers or resources associated with the DocumentReference.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "EffectEvidenceSynthesis": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "resourceType": { - "description": "This is a EffectEvidenceSynthesis resource", - "const": "EffectEvidenceSynthesis" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this effect evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the effect evidence synthesis.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the effect evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the effect evidence synthesis changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the effect evidence synthesis.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the effect evidence synthesis from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate effect evidence synthesis instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the effect evidence synthesis is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the effect evidence synthesis content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "synthesisType": { - "description": "Type of synthesis eg meta-analysis.", - "$ref": "#/definitions/CodeableConcept" - }, - "studyType": { - "description": "Type of study eg randomized trial.", - "$ref": "#/definitions/CodeableConcept" - }, - "population": { - "description": "A reference to a EvidenceVariable resource that defines the population for the research.", - "$ref": "#/definitions/Reference" - }, - "exposure": { - "description": "A reference to a EvidenceVariable resource that defines the exposure for the research.", - "$ref": "#/definitions/Reference" - }, - "exposureAlternative": { - "description": "A reference to a EvidenceVariable resource that defines the comparison exposure for the research.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "A reference to a EvidenceVariable resomece that defines the outcome for the research.", - "$ref": "#/definitions/Reference" - }, - "sampleSize": { - "description": "A description of the size of the sample involved in the synthesis.", - "$ref": "#/definitions/EffectEvidenceSynthesis_SampleSize" - }, - "resultsByExposure": { - "description": "A description of the results for each exposure considered in the effect estimate.", - "items": { - "$ref": "#/definitions/EffectEvidenceSynthesis_ResultsByExposure" - }, - "type": "array" - }, - "effectEstimate": { - "description": "The estimated effect of the exposure variant.", - "items": { - "$ref": "#/definitions/EffectEvidenceSynthesis_EffectEstimate" - }, - "type": "array" - }, - "certainty": { - "description": "A description of the certainty of the effect estimate.", - "items": { - "$ref": "#/definitions/EffectEvidenceSynthesis_Certainty" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "exposureAlternative", - "exposure", - "outcome", - "resourceType", - "population" - ] - }, - "EffectEvidenceSynthesis_SampleSize": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Human-readable summary of sample size.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "numberOfStudies": { - "description": "Number of studies included in this evidence synthesis.", - "$ref": "#/definitions/integer" - }, - "_numberOfStudies": { - "description": "Extensions for numberOfStudies", - "$ref": "#/definitions/Element" - }, - "numberOfParticipants": { - "description": "Number of participants included in this evidence synthesis.", - "$ref": "#/definitions/integer" - }, - "_numberOfParticipants": { - "description": "Extensions for numberOfParticipants", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "EffectEvidenceSynthesis_ResultsByExposure": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Human-readable summary of results by exposure state.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "exposureState": { - "description": "Whether these results are for the exposure state or alternative exposure state.", - "enum": [ - "exposure", - "exposure-alternative" - ] - }, - "_exposureState": { - "description": "Extensions for exposureState", - "$ref": "#/definitions/Element" - }, - "variantState": { - "description": "Used to define variant exposure states such as low-risk state.", - "$ref": "#/definitions/CodeableConcept" - }, - "riskEvidenceSynthesis": { - "description": "Reference to a RiskEvidenceSynthesis resource.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "riskEvidenceSynthesis" - ] - }, - "EffectEvidenceSynthesis_EffectEstimate": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Human-readable summary of effect estimate.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Examples include relative risk and mean difference.", - "$ref": "#/definitions/CodeableConcept" - }, - "variantState": { - "description": "Used to define variant exposure states such as low-risk state.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "The point estimate of the effect estimate.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "unitOfMeasure": { - "description": "Specifies the UCUM unit for the outcome.", - "$ref": "#/definitions/CodeableConcept" - }, - "precisionEstimate": { - "description": "A description of the precision of the estimate for the effect.", - "items": { - "$ref": "#/definitions/EffectEvidenceSynthesis_PrecisionEstimate" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "EffectEvidenceSynthesis_PrecisionEstimate": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Examples include confidence interval and interquartile range.", - "$ref": "#/definitions/CodeableConcept" - }, - "level": { - "description": "Use 95 for a 95% confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_level": { - "description": "Extensions for level", - "$ref": "#/definitions/Element" - }, - "from": { - "description": "Lower bound of confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_from": { - "description": "Extensions for from", - "$ref": "#/definitions/Element" - }, - "to": { - "description": "Upper bound of confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_to": { - "description": "Extensions for to", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "EffectEvidenceSynthesis_Certainty": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "rating": { - "description": "A rating of the certainty of the effect estimate.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "certaintySubcomponent": { - "description": "A description of a component of the overall certainty.", - "items": { - "$ref": "#/definitions/EffectEvidenceSynthesis_CertaintySubcomponent" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "EffectEvidenceSynthesis_CertaintySubcomponent": { - "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of subcomponent of certainty rating.", - "$ref": "#/definitions/CodeableConcept" - }, - "rating": { - "description": "A rating of a subcomponent of rating certainty.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Encounter": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "resourceType": { - "description": "This is a Encounter resource", - "const": "Encounter" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier(s) by which this encounter is known.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", - "enum": [ - "planned", - "arrived", - "triaged", - "in-progress", - "onleave", - "finished", - "cancelled", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusHistory": { - "description": "The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.", - "items": { - "$ref": "#/definitions/Encounter_StatusHistory" - }, - "type": "array" - }, - "class": { - "description": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.", - "$ref": "#/definitions/Coding" - }, - "classHistory": { - "description": "The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.", - "items": { - "$ref": "#/definitions/Encounter_ClassHistory" - }, - "type": "array" - }, - "type": { - "description": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "serviceType": { - "description": "Broad categorization of the service that is to be provided (e.g. cardiology).", - "$ref": "#/definitions/CodeableConcept" - }, - "priority": { - "description": "Indicates the urgency of the encounter.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The patient or group present at the encounter.", - "$ref": "#/definitions/Reference" - }, - "episodeOfCare": { - "description": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "basedOn": { - "description": "The request this encounter satisfies (e.g. incoming referral or procedure request).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "participant": { - "description": "The list of people responsible for providing the service.", - "items": { - "$ref": "#/definitions/Encounter_Participant" - }, - "type": "array" - }, - "appointment": { - "description": "The appointment that scheduled this encounter.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "period": { - "description": "The start and end time of the encounter.", - "$ref": "#/definitions/Period" - }, - "length": { - "description": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.", - "$ref": "#/definitions/Duration" - }, - "reasonCode": { - "description": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "diagnosis": { - "description": "The list of diagnosis relevant to this encounter.", - "items": { - "$ref": "#/definitions/Encounter_Diagnosis" - }, - "type": "array" - }, - "account": { - "description": "The set of accounts that may be used for billing for this Encounter.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "hospitalization": { - "description": "Details about the admission to a healthcare service.", - "$ref": "#/definitions/Encounter_Hospitalization" - }, - "location": { - "description": "List of locations where the patient has been during this encounter.", - "items": { - "$ref": "#/definitions/Encounter_Location" - }, - "type": "array" - }, - "serviceProvider": { - "description": "The organization that is primarily responsible for this Encounter\u0027s services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.", - "$ref": "#/definitions/Reference" - }, - "partOf": { - "description": "Another Encounter of which this encounter is a part of (administratively or in time).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "class", - "resourceType" - ] - }, - "Encounter_StatusHistory": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "status": { - "description": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", - "enum": [ - "planned", - "arrived", - "triaged", - "in-progress", - "onleave", - "finished", - "cancelled", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The time that the episode was in the specified status.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "period" - ] - }, - "Encounter_ClassHistory": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "class": { - "description": "inpatient | outpatient | ambulatory | emergency +.", - "$ref": "#/definitions/Coding" - }, - "period": { - "description": "The time that the episode was in the specified class.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "period", - "class" - ] - }, - "Encounter_Participant": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Role of participant in encounter.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "period": { - "description": "The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter\u0027s period.", - "$ref": "#/definitions/Period" - }, - "individual": { - "description": "Persons involved in the encounter other than the patient.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Encounter_Diagnosis": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "condition": { - "description": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.", - "$ref": "#/definitions/Reference" - }, - "use": { - "description": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).", - "$ref": "#/definitions/CodeableConcept" - }, - "rank": { - "description": "Ranking of the diagnosis (for each role type).", - "$ref": "#/definitions/positiveInt" - }, - "_rank": { - "description": "Extensions for rank", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "condition" - ] - }, - "Encounter_Hospitalization": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "preAdmissionIdentifier": { - "description": "Pre-admission identifier.", - "$ref": "#/definitions/Identifier" - }, - "origin": { - "description": "The location/organization from which the patient came before admission.", - "$ref": "#/definitions/Reference" - }, - "admitSource": { - "description": "From where patient was admitted (physician referral, transfer).", - "$ref": "#/definitions/CodeableConcept" - }, - "reAdmission": { - "description": "Whether this hospitalization is a readmission and why if known.", - "$ref": "#/definitions/CodeableConcept" - }, - "dietPreference": { - "description": "Diet preferences reported by the patient.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialCourtesy": { - "description": "Special courtesies (VIP, board member).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialArrangement": { - "description": "Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "destination": { - "description": "Location/organization to which the patient is discharged.", - "$ref": "#/definitions/Reference" - }, - "dischargeDisposition": { - "description": "Category or kind of location after discharge.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "Encounter_Location": { - "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "location": { - "description": "The location where the encounter takes place.", - "$ref": "#/definitions/Reference" - }, - "status": { - "description": "The status of the participants\u0027 presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.", - "enum": [ - "planned", - "active", - "reserved", - "completed" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "physicalType": { - "description": "This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.", - "$ref": "#/definitions/CodeableConcept" - }, - "period": { - "description": "Time period during which the patient was present at the location.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "location" - ] - }, - "Endpoint": { - "description": "The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.", - "properties": { - "resourceType": { - "description": "This is a Endpoint resource", - "const": "Endpoint" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "active | suspended | error | off | test.", - "enum": [ - "active", - "suspended", - "error", - "off", - "entered-in-error", - "test" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "connectionType": { - "description": "A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).", - "$ref": "#/definitions/Coding" - }, - "name": { - "description": "A friendly name that this endpoint can be referred to with.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "managingOrganization": { - "description": "The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).", - "$ref": "#/definitions/Reference" - }, - "contact": { - "description": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "period": { - "description": "The interval during which the endpoint is expected to be operational.", - "$ref": "#/definitions/Period" - }, - "payloadType": { - "description": "The payload type describes the acceptable content that can be communicated on the endpoint.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "payloadMimeType": { - "description": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_payloadMimeType": { - "description": "Extensions for payloadMimeType", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "address": { - "description": "The uri that describes the actual end-point to connect to.", - "$ref": "#/definitions/url" - }, - "_address": { - "description": "Extensions for address", - "$ref": "#/definitions/Element" - }, - "header": { - "description": "Additional headers / information to send as part of the notification.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_header": { - "description": "Extensions for header", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "payloadType", - "connectionType", - "resourceType" - ] - }, - "EnrollmentRequest": { - "description": "This resource provides the insurance enrollment details to the insurer regarding a specified coverage.", - "properties": { - "resourceType": { - "description": "This is a EnrollmentRequest resource", - "const": "EnrollmentRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The Response business identifier.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "created": { - "description": "The date when this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "insurer": { - "description": "The Insurer who is target of the request.", - "$ref": "#/definitions/Reference" - }, - "provider": { - "description": "The practitioner who is responsible for the services rendered to the patient.", - "$ref": "#/definitions/Reference" - }, - "candidate": { - "description": "Patient Resource.", - "$ref": "#/definitions/Reference" - }, - "coverage": { - "description": "Reference to the program or plan identification, underwriter or payor.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "EnrollmentResponse": { - "description": "This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.", - "properties": { - "resourceType": { - "description": "This is a EnrollmentResponse resource", - "const": "EnrollmentResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The Response business identifier.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "request": { - "description": "Original request resource reference.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "Processing status: error, complete.", - "enum": [ - "queued", - "complete", - "error", - "partial" - ] - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "disposition": { - "description": "A description of the status of the adjudication.", - "$ref": "#/definitions/string" - }, - "_disposition": { - "description": "Extensions for disposition", - "$ref": "#/definitions/Element" - }, - "created": { - "description": "The date when the enclosed suite of services were performed or completed.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "organization": { - "description": "The Insurer who produced this adjudicated response.", - "$ref": "#/definitions/Reference" - }, - "requestProvider": { - "description": "The practitioner who is responsible for the services rendered to the patient.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "EpisodeOfCare": { - "description": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.", - "properties": { - "resourceType": { - "description": "This is a EpisodeOfCare resource", - "const": "EpisodeOfCare" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "planned | waitlist | active | onhold | finished | cancelled.", - "enum": [ - "planned", - "waitlist", - "active", - "onhold", - "finished", - "cancelled", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusHistory": { - "description": "The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).", - "items": { - "$ref": "#/definitions/EpisodeOfCare_StatusHistory" - }, - "type": "array" - }, - "type": { - "description": "A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "diagnosis": { - "description": "The list of diagnosis relevant to this episode of care.", - "items": { - "$ref": "#/definitions/EpisodeOfCare_Diagnosis" - }, - "type": "array" - }, - "patient": { - "description": "The patient who is the focus of this episode of care.", - "$ref": "#/definitions/Reference" - }, - "managingOrganization": { - "description": "The organization that has assumed the specific responsibilities for the specified duration.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "The interval during which the managing organization assumes the defined responsibility.", - "$ref": "#/definitions/Period" - }, - "referralRequest": { - "description": "Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "careManager": { - "description": "The practitioner that is the care manager/care coordinator for this patient.", - "$ref": "#/definitions/Reference" - }, - "team": { - "description": "The list of practitioners that may be facilitating this episode of care for specific purposes.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "account": { - "description": "The set of accounts that may be used for billing for this EpisodeOfCare.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "resourceType" - ] - }, - "EpisodeOfCare_StatusHistory": { - "description": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "status": { - "description": "planned | waitlist | active | onhold | finished | cancelled.", - "enum": [ - "planned", - "waitlist", - "active", - "onhold", - "finished", - "cancelled", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period during this EpisodeOfCare that the specific status applied.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "period" - ] - }, - "EpisodeOfCare_Diagnosis": { - "description": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "condition": { - "description": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.", - "$ref": "#/definitions/Reference" - }, - "role": { - "description": "Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).", - "$ref": "#/definitions/CodeableConcept" - }, - "rank": { - "description": "Ranking of the diagnosis (for each role type).", - "$ref": "#/definitions/positiveInt" - }, - "_rank": { - "description": "Extensions for rank", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "condition" - ] - }, - "EventDefinition": { - "description": "The EventDefinition resource provides a reusable description of when a particular event can occur.", - "properties": { - "resourceType": { - "description": "This is a EventDefinition resource", - "const": "EventDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the event definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the event definition giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this event definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "A code or group definition that describes the intended subject of the event definition.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "A code or group definition that describes the intended subject of the event definition.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the event definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the event definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the event definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this event definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description of how the event definition is used from a clinical perspective.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the event definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related resources such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "trigger": { - "description": "The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.", - "items": { - "$ref": "#/definitions/TriggerDefinition" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "trigger", - "resourceType" - ] - }, - "Evidence": { - "description": "The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "resourceType": { - "description": "This is a Evidence resource", - "const": "Evidence" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the evidence.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "shortTitle": { - "description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.", - "$ref": "#/definitions/string" - }, - "_shortTitle": { - "description": "Extensions for shortTitle", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the Evidence giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this evidence. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the evidence.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the evidence from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the evidence is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the evidence content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "exposureBackground": { - "description": "A reference to a EvidenceVariable resource that defines the population for the research.", - "$ref": "#/definitions/Reference" - }, - "exposureVariant": { - "description": "A reference to a EvidenceVariable resource that defines the exposure for the research.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "outcome": { - "description": "A reference to a EvidenceVariable resomece that defines the outcome for the research.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "exposureBackground", - "resourceType" - ] - }, - "EvidenceVariable": { - "description": "The EvidenceVariable resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "resourceType": { - "description": "This is a EvidenceVariable resource", - "const": "EvidenceVariable" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the evidence variable.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "shortTitle": { - "description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.", - "$ref": "#/definitions/string" - }, - "_shortTitle": { - "description": "Extensions for shortTitle", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the EvidenceVariable giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this evidence variable. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the evidence variable.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the evidence variable from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the evidence variable is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the evidence variable content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "type": { - "description": "The type of evidence element, a population, an exposure, or an outcome.", - "enum": [ - "dichotomous", - "continuous", - "descriptive" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "characteristic": { - "description": "A characteristic that defines the members of the evidence element. Multiple characteristics are applied with \"and\" semantics.", - "items": { - "$ref": "#/definitions/EvidenceVariable_Characteristic" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "characteristic", - "resourceType" - ] - }, - "EvidenceVariable_Characteristic": { - "description": "The EvidenceVariable resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "definitionReference": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/Reference" - }, - "definitionCanonical": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "pattern": "^\\S*$", - "type": "string" - }, - "_definitionCanonical": { - "description": "Extensions for definitionCanonical", - "$ref": "#/definitions/Element" - }, - "definitionCodeableConcept": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/CodeableConcept" - }, - "definitionExpression": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/Expression" - }, - "definitionDataRequirement": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/DataRequirement" - }, - "definitionTriggerDefinition": { - "description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/TriggerDefinition" - }, - "usageContext": { - "description": "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "exclude": { - "description": "When true, members with this characteristic are excluded from the element.", - "$ref": "#/definitions/boolean" - }, - "_exclude": { - "description": "Extensions for exclude", - "$ref": "#/definitions/Element" - }, - "participantEffectiveDateTime": { - "description": "Indicates what effective period the study covers.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_participantEffectiveDateTime": { - "description": "Extensions for participantEffectiveDateTime", - "$ref": "#/definitions/Element" - }, - "participantEffectivePeriod": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Period" - }, - "participantEffectiveDuration": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Duration" - }, - "participantEffectiveTiming": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Timing" - }, - "timeFromStart": { - "description": "Indicates duration from the participant\u0027s study entry.", - "$ref": "#/definitions/Duration" - }, - "groupMeasure": { - "description": "Indicates how elements are aggregated within the study effective period.", - "enum": [ - "mean", - "median", - "mean-of-mean", - "mean-of-median", - "median-of-mean", - "median-of-median" - ] - }, - "_groupMeasure": { - "description": "Extensions for groupMeasure", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ExampleScenario": { - "description": "Example of workflow instance.", - "properties": { - "resourceType": { - "description": "This is a ExampleScenario resource", - "const": "ExampleScenario" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this example scenario. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the \u0027content logical definition\u0027).", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the example scenario.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the example scenario is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "purpose": { - "description": "What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "actor": { - "description": "Actor participating in the resource.", - "items": { - "$ref": "#/definitions/ExampleScenario_Actor" - }, - "type": "array" - }, - "instance": { - "description": "Each resource and each version that is present in the workflow.", - "items": { - "$ref": "#/definitions/ExampleScenario_Instance" - }, - "type": "array" - }, - "process": { - "description": "Each major process - a group of operations.", - "items": { - "$ref": "#/definitions/ExampleScenario_Process" - }, - "type": "array" - }, - "workflow": { - "description": "Another nested workflow.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ExampleScenario_Actor": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "actorId": { - "description": "ID or acronym of actor.", - "$ref": "#/definitions/string" - }, - "_actorId": { - "description": "Extensions for actorId", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of actor - person or system.", - "enum": [ - "person", - "entity" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "The name of the actor as shown in the page.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "The description of the actor.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Instance": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "resourceId": { - "description": "The id of the resource for referencing.", - "$ref": "#/definitions/string" - }, - "_resourceId": { - "description": "Extensions for resourceId", - "$ref": "#/definitions/Element" - }, - "resourceType": { - "description": "The type of the resource.", - "$ref": "#/definitions/code" - }, - "_resourceType": { - "description": "Extensions for resourceType", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A short name for the resource instance.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Human-friendly description of the resource instance.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "A specific version of the resource.", - "items": { - "$ref": "#/definitions/ExampleScenario_Version" - }, - "type": "array" - }, - "containedInstance": { - "description": "Resources contained in the instance (e.g. the observations contained in a bundle).", - "items": { - "$ref": "#/definitions/ExampleScenario_ContainedInstance" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Version": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "versionId": { - "description": "The identifier of a specific version of a resource.", - "$ref": "#/definitions/string" - }, - "_versionId": { - "description": "Extensions for versionId", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "The description of the resource version.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ExampleScenario_ContainedInstance": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "resourceId": { - "description": "Each resource contained in the instance.", - "$ref": "#/definitions/string" - }, - "_resourceId": { - "description": "Extensions for resourceId", - "$ref": "#/definitions/Element" - }, - "versionId": { - "description": "A specific version of a resource contained in the instance.", - "$ref": "#/definitions/string" - }, - "_versionId": { - "description": "Extensions for versionId", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Process": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "title": { - "description": "The diagram title of the group of operations.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A longer description of the group of operations.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "preConditions": { - "description": "Description of initial status before the process starts.", - "$ref": "#/definitions/markdown" - }, - "_preConditions": { - "description": "Extensions for preConditions", - "$ref": "#/definitions/Element" - }, - "postConditions": { - "description": "Description of final status after the process ends.", - "$ref": "#/definitions/markdown" - }, - "_postConditions": { - "description": "Extensions for postConditions", - "$ref": "#/definitions/Element" - }, - "step": { - "description": "Each step of the process.", - "items": { - "$ref": "#/definitions/ExampleScenario_Step" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Step": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "process": { - "description": "Nested process.", - "items": { - "$ref": "#/definitions/ExampleScenario_Process" - }, - "type": "array" - }, - "pause": { - "description": "If there is a pause in the flow.", - "$ref": "#/definitions/boolean" - }, - "_pause": { - "description": "Extensions for pause", - "$ref": "#/definitions/Element" - }, - "operation": { - "description": "Each interaction or action.", - "$ref": "#/definitions/ExampleScenario_Operation" - }, - "alternative": { - "description": "Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.", - "items": { - "$ref": "#/definitions/ExampleScenario_Alternative" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Operation": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "number": { - "description": "The sequential number of the interaction, e.g. 1.2.5.", - "$ref": "#/definitions/string" - }, - "_number": { - "description": "Extensions for number", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of operation - CRUD.", - "$ref": "#/definitions/string" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "The human-friendly name of the interaction.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "initiator": { - "description": "Who starts the transaction.", - "$ref": "#/definitions/string" - }, - "_initiator": { - "description": "Extensions for initiator", - "$ref": "#/definitions/Element" - }, - "receiver": { - "description": "Who receives the transaction.", - "$ref": "#/definitions/string" - }, - "_receiver": { - "description": "Extensions for receiver", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A comment to be inserted in the diagram.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "initiatorActive": { - "description": "Whether the initiator is deactivated right after the transaction.", - "$ref": "#/definitions/boolean" - }, - "_initiatorActive": { - "description": "Extensions for initiatorActive", - "$ref": "#/definitions/Element" - }, - "receiverActive": { - "description": "Whether the receiver is deactivated right after the transaction.", - "$ref": "#/definitions/boolean" - }, - "_receiverActive": { - "description": "Extensions for receiverActive", - "$ref": "#/definitions/Element" - }, - "request": { - "description": "Each resource instance used by the initiator.", - "$ref": "#/definitions/ExampleScenario_ContainedInstance" - }, - "response": { - "description": "Each resource instance used by the responder.", - "$ref": "#/definitions/ExampleScenario_ContainedInstance" - } - }, - "additionalProperties": false - }, - "ExampleScenario_Alternative": { - "description": "Example of workflow instance.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "title": { - "description": "The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A human-readable description of the alternative explaining when the alternative should occur rather than the base step.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "step": { - "description": "What happens in each alternative option.", - "items": { - "$ref": "#/definitions/ExampleScenario_Step" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "resourceType": { - "description": "This is a ExplanationOfBenefit resource", - "const": "ExplanationOfBenefit" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this explanation of benefit.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "enum": [ - "active", - "cancelled", - "draft", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The category of claim, e.g. oral, pharmacy, vision, institutional, professional.", - "$ref": "#/definitions/CodeableConcept" - }, - "subType": { - "description": "A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.", - "$ref": "#/definitions/CodeableConcept" - }, - "use": { - "description": "A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.", - "$ref": "#/definitions/code" - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.", - "$ref": "#/definitions/Reference" - }, - "billablePeriod": { - "description": "The period for which charges are being submitted.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "The date this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "enterer": { - "description": "Individual who created the claim, predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "insurer": { - "description": "The party responsible for authorization, adjudication and reimbursement.", - "$ref": "#/definitions/Reference" - }, - "provider": { - "description": "The provider which is responsible for the claim, predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "priority": { - "description": "The provider-required urgency of processing the request. Typical values include: stat, routine deferred.", - "$ref": "#/definitions/CodeableConcept" - }, - "fundsReserveRequested": { - "description": "A code to indicate whether and for whom funds are to be reserved for future claims.", - "$ref": "#/definitions/CodeableConcept" - }, - "fundsReserve": { - "description": "A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.", - "$ref": "#/definitions/CodeableConcept" - }, - "related": { - "description": "Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Related" - }, - "type": "array" - }, - "prescription": { - "description": "Prescription to support the dispensing of pharmacy, device or vision products.", - "$ref": "#/definitions/Reference" - }, - "originalPrescription": { - "description": "Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.", - "$ref": "#/definitions/Reference" - }, - "payee": { - "description": "The party to be reimbursed for cost of the products and services according to the terms of the policy.", - "$ref": "#/definitions/ExplanationOfBenefit_Payee" - }, - "referral": { - "description": "A reference to a referral resource.", - "$ref": "#/definitions/Reference" - }, - "facility": { - "description": "Facility where the services were provided.", - "$ref": "#/definitions/Reference" - }, - "claim": { - "description": "The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.", - "$ref": "#/definitions/Reference" - }, - "claimResponse": { - "description": "The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "The outcome of the claim, predetermination, or preauthorization processing.", - "$ref": "#/definitions/code" - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "disposition": { - "description": "A human readable description of the status of the adjudication.", - "$ref": "#/definitions/string" - }, - "_disposition": { - "description": "Extensions for disposition", - "$ref": "#/definitions/Element" - }, - "preAuthRef": { - "description": "Reference from the Insurer which is used in later communications which refers to this adjudication.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_preAuthRef": { - "description": "Extensions for preAuthRef", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "preAuthRefPeriod": { - "description": "The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.", - "items": { - "$ref": "#/definitions/Period" - }, - "type": "array" - }, - "careTeam": { - "description": "The members of the team who provided the products and services.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_CareTeam" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_SupportingInfo" - }, - "type": "array" - }, - "diagnosis": { - "description": "Information about diagnoses relevant to the claim items.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Diagnosis" - }, - "type": "array" - }, - "procedure": { - "description": "Procedures performed on the patient relevant to the billing items with the claim.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Procedure" - }, - "type": "array" - }, - "precedence": { - "description": "This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.", - "$ref": "#/definitions/positiveInt" - }, - "_precedence": { - "description": "Extensions for precedence", - "$ref": "#/definitions/Element" - }, - "insurance": { - "description": "Financial instruments for reimbursement for the health care products and services specified on the claim.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Insurance" - }, - "type": "array" - }, - "accident": { - "description": "Details of a accident which resulted in injuries which required the products and services listed in the claim.", - "$ref": "#/definitions/ExplanationOfBenefit_Accident" - }, - "item": { - "description": "A claim line. Either a simple (a product or service) or a \u0027group\u0027 of details which can also be a simple items or groups of sub-details.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Item" - }, - "type": "array" - }, - "addItem": { - "description": "The first-tier service adjudications for payor added product or service lines.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_AddItem" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results which are presented at the header level rather than at the line-item or add-item levels.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - }, - "total": { - "description": "Categorized monetary totals for the adjudication.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Total" - }, - "type": "array" - }, - "payment": { - "description": "Payment details for the adjudication of the claim.", - "$ref": "#/definitions/ExplanationOfBenefit_Payment" - }, - "formCode": { - "description": "A code for the form to be used for printing the content.", - "$ref": "#/definitions/CodeableConcept" - }, - "form": { - "description": "The actual form, by reference or inclusion, for printing the content or an EOB.", - "$ref": "#/definitions/Attachment" - }, - "processNote": { - "description": "A note that describes or explains adjudication results in a human readable form.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_ProcessNote" - }, - "type": "array" - }, - "benefitPeriod": { - "description": "The term of the benefits documented in this response.", - "$ref": "#/definitions/Period" - }, - "benefitBalance": { - "description": "Balance by Benefit Category.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_BenefitBalance" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "insurance", - "provider", - "patient", - "insurer", - "type", - "resourceType" - ] - }, - "ExplanationOfBenefit_Related": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "claim": { - "description": "Reference to a related claim.", - "$ref": "#/definitions/Reference" - }, - "relationship": { - "description": "A code to convey how the claims are related.", - "$ref": "#/definitions/CodeableConcept" - }, - "reference": { - "description": "An alternate organizational reference to the case or file to which this particular claim pertains.", - "$ref": "#/definitions/Identifier" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_Payee": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of Party to be reimbursed: Subscriber, provider, other.", - "$ref": "#/definitions/CodeableConcept" - }, - "party": { - "description": "Reference to the individual or organization to whom any payment will be made.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_CareTeam": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify care team entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "provider": { - "description": "Member of the team who provided the product or service.", - "$ref": "#/definitions/Reference" - }, - "responsible": { - "description": "The party who is billing and/or responsible for the claimed products or services.", - "$ref": "#/definitions/boolean" - }, - "_responsible": { - "description": "Extensions for responsible", - "$ref": "#/definitions/Element" - }, - "role": { - "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team.", - "$ref": "#/definitions/CodeableConcept" - }, - "qualification": { - "description": "The qualification of the practitioner which is applicable for this service.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "provider" - ] - }, - "ExplanationOfBenefit_SupportingInfo": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify supporting information entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "The general class of the information supplied: information; exception; accident, employment; onset, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought.", - "$ref": "#/definitions/CodeableConcept" - }, - "timingDate": { - "description": "The date when or period to which this information refers.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_timingDate": { - "description": "Extensions for timingDate", - "$ref": "#/definitions/Element" - }, - "timingPeriod": { - "description": "The date when or period to which this information refers.", - "$ref": "#/definitions/Period" - }, - "valueBoolean": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueQuantity": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Quantity" - }, - "valueAttachment": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Attachment" - }, - "valueReference": { - "description": "Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.", - "$ref": "#/definitions/Reference" - }, - "reason": { - "description": "Provides the reason in the situation where a reason code is required in addition to the content.", - "$ref": "#/definitions/Coding" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "ExplanationOfBenefit_Diagnosis": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify diagnosis entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "diagnosisCodeableConcept": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/CodeableConcept" - }, - "diagnosisReference": { - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "When the condition was observed or the relative ranking.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "onAdmission": { - "description": "Indication of whether the diagnosis was present on admission to a facility.", - "$ref": "#/definitions/CodeableConcept" - }, - "packageCode": { - "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_Procedure": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify procedure entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "When the condition was observed or the relative ranking.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "date": { - "description": "Date and optionally time the procedure was performed.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "procedureCodeableConcept": { - "description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "procedureReference": { - "description": "The code or reference to a Procedure resource which identifies the clinical intervention performed.", - "$ref": "#/definitions/Reference" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_Insurance": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "focal": { - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.", - "$ref": "#/definitions/boolean" - }, - "_focal": { - "description": "Extensions for focal", - "$ref": "#/definitions/Element" - }, - "coverage": { - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient\u0027s actual coverage within the insurer\u0027s information system.", - "$ref": "#/definitions/Reference" - }, - "preAuthRef": { - "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_preAuthRef": { - "description": "Extensions for preAuthRef", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "coverage" - ] - }, - "ExplanationOfBenefit_Accident": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "date": { - "description": "Date of an accident event related to the products and services contained in the claim.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "The physical location of the accident event.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "The physical location of the accident event.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_Item": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A number to uniquely identify item entries.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "careTeamSequence": { - "description": "Care team members related to this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_careTeamSequence": { - "description": "Extensions for careTeamSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "diagnosisSequence": { - "description": "Diagnoses applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_diagnosisSequence": { - "description": "Extensions for diagnosisSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "procedureSequence": { - "description": "Procedures applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_procedureSequence": { - "description": "Extensions for procedureSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "informationSequence": { - "description": "Exceptions, special conditions and supporting information applicable for this service or product.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_informationSequence": { - "description": "Extensions for informationSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "servicedDate": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "$ref": "#/definitions/Period" - }, - "locationCodeableConcept": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "Physical service site on the patient (limb, tooth, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "subSite": { - "description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "encounter": { - "description": "A billed item may include goods or services provided in multiple encounters.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - }, - "detail": { - "description": "Second-tier of goods and services.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Detail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_Adjudication": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.", - "$ref": "#/definitions/CodeableConcept" - }, - "reason": { - "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Monetary amount associated with the category.", - "$ref": "#/definitions/Money" - }, - "value": { - "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "ExplanationOfBenefit_Detail": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - }, - "subDetail": { - "description": "Third-tier of goods and services.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_SubDetail" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_SubDetail": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "A claim detail line. Either a simple (a product or service) or a \u0027group\u0027 of sub-details which are simple items.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "revenue": { - "description": "The type of revenue or cost center providing the product and/or service.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "udi": { - "description": "Unique Device Identifiers associated with this line item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_AddItem": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemSequence": { - "description": "Claim items which this service line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_itemSequence": { - "description": "Extensions for itemSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "detailSequence": { - "description": "The sequence number of the details within the claim item which this line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_detailSequence": { - "description": "Extensions for detailSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "subDetailSequence": { - "description": "The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_subDetailSequence": { - "description": "Extensions for subDetailSequence", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "provider": { - "description": "The providers who are authorized for the services rendered to the patient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "programCode": { - "description": "Identifies the program under which this may be recovered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "servicedDate": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_servicedDate": { - "description": "Extensions for servicedDate", - "$ref": "#/definitions/Element" - }, - "servicedPeriod": { - "description": "The date or dates when the service or product was supplied, performed or completed.", - "$ref": "#/definitions/Period" - }, - "locationCodeableConcept": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "locationAddress": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Address" - }, - "locationReference": { - "description": "Where the product or service was provided.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "bodySite": { - "description": "Physical service site on the patient (limb, tooth, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "subSite": { - "description": "A region or surface of the bodySite, e.g. limb region or tooth surface(s).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - }, - "detail": { - "description": "The second-tier service adjudications for payor added services.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Detail1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_Detail1": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - }, - "subDetail": { - "description": "The third-tier service adjudications for payor added services.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_SubDetail1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_SubDetail1": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "productOrService": { - "description": "When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.", - "$ref": "#/definitions/CodeableConcept" - }, - "modifier": { - "description": "Item typification or modifiers codes to convey additional context for the product or service.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantity": { - "description": "The number of repetitions of a service or product.", - "$ref": "#/definitions/Quantity" - }, - "unitPrice": { - "description": "If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.", - "$ref": "#/definitions/Money" - }, - "factor": { - "description": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "net": { - "description": "The quantity times the unit price for an additional service or product or charge.", - "$ref": "#/definitions/Money" - }, - "noteNumber": { - "description": "The numbers associated with notes below which apply to the adjudication of this item.", - "items": { - "$ref": "#/definitions/positiveInt" - }, - "type": "array" - }, - "_noteNumber": { - "description": "Extensions for noteNumber", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "adjudication": { - "description": "The adjudication results.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Adjudication" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "productOrService" - ] - }, - "ExplanationOfBenefit_Total": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Monetary total amount associated with the category.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "amount", - "category" - ] - }, - "ExplanationOfBenefit_Payment": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Whether this represents partial or complete payment of the benefits payable.", - "$ref": "#/definitions/CodeableConcept" - }, - "adjustment": { - "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim\u0027s adjudication.", - "$ref": "#/definitions/Money" - }, - "adjustmentReason": { - "description": "Reason for the payment adjustment.", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "Estimated date the payment will be issued or the actual issue date of payment.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "Benefits payable less any payment adjustment.", - "$ref": "#/definitions/Money" - }, - "identifier": { - "description": "Issuer\u0027s unique identifier for the payment instrument.", - "$ref": "#/definitions/Identifier" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_ProcessNote": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "number": { - "description": "A number to uniquely identify a note entry.", - "$ref": "#/definitions/positiveInt" - }, - "_number": { - "description": "Extensions for number", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The business purpose of the note text.", - "enum": [ - "display", - "print", - "printoper" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "The explanation or description associated with the processing.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "A code to define the language used in the text of the note.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ExplanationOfBenefit_BenefitBalance": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "Code to identify the general type of benefits under which products and services are provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "excluded": { - "description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.", - "$ref": "#/definitions/boolean" - }, - "_excluded": { - "description": "Extensions for excluded", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A short name or tag for the benefit.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A richer description of the benefit or services covered.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "network": { - "description": "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.", - "$ref": "#/definitions/CodeableConcept" - }, - "unit": { - "description": "Indicates if the benefits apply to an individual or to the family.", - "$ref": "#/definitions/CodeableConcept" - }, - "term": { - "description": "The term or period of the values such as \u0027maximum lifetime benefit\u0027 or \u0027maximum annual visits\u0027.", - "$ref": "#/definitions/CodeableConcept" - }, - "financial": { - "description": "Benefits Used to date.", - "items": { - "$ref": "#/definitions/ExplanationOfBenefit_Financial" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "ExplanationOfBenefit_Financial": { - "description": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Classification of benefit being provided.", - "$ref": "#/definitions/CodeableConcept" - }, - "allowedUnsignedInt": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_allowedUnsignedInt": { - "description": "Extensions for allowedUnsignedInt", - "$ref": "#/definitions/Element" - }, - "allowedString": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_allowedString": { - "description": "Extensions for allowedString", - "$ref": "#/definitions/Element" - }, - "allowedMoney": { - "description": "The quantity of the benefit which is permitted under the coverage.", - "$ref": "#/definitions/Money" - }, - "usedUnsignedInt": { - "description": "The quantity of the benefit which have been consumed to date.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_usedUnsignedInt": { - "description": "Extensions for usedUnsignedInt", - "$ref": "#/definitions/Element" - }, - "usedMoney": { - "description": "The quantity of the benefit which have been consumed to date.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "FamilyMemberHistory": { - "description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.", - "properties": { - "resourceType": { - "description": "This is a FamilyMemberHistory resource", - "const": "FamilyMemberHistory" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "status": { - "description": "A code specifying the status of the record of the family history of a specific family member.", - "enum": [ - "partial", - "completed", - "entered-in-error", - "health-unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "dataAbsentReason": { - "description": "Describes why the family member\u0027s history is not available.", - "$ref": "#/definitions/CodeableConcept" - }, - "patient": { - "description": "The person who this history concerns.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and possibly time) when the family member history was recorded or last updated.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "relationship": { - "description": "The type of relationship this person has to the patient (father, mother, brother etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "sex": { - "description": "The birth sex of the family member.", - "$ref": "#/definitions/CodeableConcept" - }, - "bornPeriod": { - "description": "The actual or approximate date of birth of the relative.", - "$ref": "#/definitions/Period" - }, - "bornDate": { - "description": "The actual or approximate date of birth of the relative.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_bornDate": { - "description": "Extensions for bornDate", - "$ref": "#/definitions/Element" - }, - "bornString": { - "description": "The actual or approximate date of birth of the relative.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_bornString": { - "description": "Extensions for bornString", - "$ref": "#/definitions/Element" - }, - "ageAge": { - "description": "The age of the relative at the time the family member history is recorded.", - "$ref": "#/definitions/Age" - }, - "ageRange": { - "description": "The age of the relative at the time the family member history is recorded.", - "$ref": "#/definitions/Range" - }, - "ageString": { - "description": "The age of the relative at the time the family member history is recorded.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_ageString": { - "description": "Extensions for ageString", - "$ref": "#/definitions/Element" - }, - "estimatedAge": { - "description": "If true, indicates that the age value specified is an estimated value.", - "$ref": "#/definitions/boolean" - }, - "_estimatedAge": { - "description": "Extensions for estimatedAge", - "$ref": "#/definitions/Element" - }, - "deceasedBoolean": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_deceasedBoolean": { - "description": "Extensions for deceasedBoolean", - "$ref": "#/definitions/Element" - }, - "deceasedAge": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", - "$ref": "#/definitions/Age" - }, - "deceasedRange": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", - "$ref": "#/definitions/Range" - }, - "deceasedDate": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_deceasedDate": { - "description": "Extensions for deceasedDate", - "$ref": "#/definitions/Element" - }, - "deceasedString": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_deceasedString": { - "description": "Extensions for deceasedString", - "$ref": "#/definitions/Element" - }, - "reasonCode": { - "description": "Describes why the family member history occurred in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "condition": { - "description": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.", - "items": { - "$ref": "#/definitions/FamilyMemberHistory_Condition" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "relationship", - "resourceType" - ] - }, - "FamilyMemberHistory_Condition": { - "description": "Significant health conditions for a person related to the patient relevant in the context of care for the patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like \u0027cancer\u0027 depending on how much is known about the condition and the capabilities of the creating system.", - "$ref": "#/definitions/CodeableConcept" - }, - "outcome": { - "description": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.", - "$ref": "#/definitions/CodeableConcept" - }, - "contributedToDeath": { - "description": "This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.", - "$ref": "#/definitions/boolean" - }, - "_contributedToDeath": { - "description": "Extensions for contributedToDeath", - "$ref": "#/definitions/Element" - }, - "onsetAge": { - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "$ref": "#/definitions/Age" - }, - "onsetRange": { - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "$ref": "#/definitions/Range" - }, - "onsetPeriod": { - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "$ref": "#/definitions/Period" - }, - "onsetString": { - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_onsetString": { - "description": "Extensions for onsetString", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "An area where general notes can be placed about this specific condition.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "Flag": { - "description": "Prospective warnings of potential issues when providing care to the patient.", - "properties": { - "resourceType": { - "description": "This is a Flag resource", - "const": "Flag" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Supports basic workflow.", - "enum": [ - "active", - "inactive", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "code": { - "description": "The coded value or textual component of the flag to display to the user.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.", - "$ref": "#/definitions/Period" - }, - "encounter": { - "description": "This alert is only relevant during the encounter.", - "$ref": "#/definitions/Reference" - }, - "author": { - "description": "The person, organization or device that created the flag.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "code", - "subject", - "resourceType" - ] - }, - "Goal": { - "description": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.", - "properties": { - "resourceType": { - "description": "This is a Goal resource", - "const": "Goal" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "lifecycleStatus": { - "description": "The state of the goal throughout its lifecycle.", - "enum": [ - "proposed", - "planned", - "accepted", - "active", - "on-hold", - "completed", - "cancelled", - "entered-in-error", - "rejected" - ] - }, - "_lifecycleStatus": { - "description": "Extensions for lifecycleStatus", - "$ref": "#/definitions/Element" - }, - "achievementStatus": { - "description": "Describes the progression, or lack thereof, towards the goal against the target.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Indicates a category the goal falls within.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "priority": { - "description": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Identifies the patient, group or organization for whom the goal is being established.", - "$ref": "#/definitions/Reference" - }, - "startDate": { - "description": "The date or event after which the goal should begin being pursued.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_startDate": { - "description": "Extensions for startDate", - "$ref": "#/definitions/Element" - }, - "startCodeableConcept": { - "description": "The date or event after which the goal should begin being pursued.", - "$ref": "#/definitions/CodeableConcept" - }, - "target": { - "description": "Indicates what should be done by when.", - "items": { - "$ref": "#/definitions/Goal_Target" - }, - "type": "array" - }, - "statusDate": { - "description": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.", - "$ref": "#/definitions/date" - }, - "_statusDate": { - "description": "Extensions for statusDate", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current status.", - "$ref": "#/definitions/string" - }, - "_statusReason": { - "description": "Extensions for statusReason", - "$ref": "#/definitions/Element" - }, - "expressedBy": { - "description": "Indicates whose goal this is - patient goal, practitioner goal, etc.", - "$ref": "#/definitions/Reference" - }, - "addresses": { - "description": "The identified conditions and other health record elements that are intended to be addressed by the goal.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Any comments related to the goal.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "outcomeCode": { - "description": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "outcomeReference": { - "description": "Details of what\u0027s changed (or not changed).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "description", - "resourceType" - ] - }, - "Goal_Target": { - "description": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "measure": { - "description": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", - "$ref": "#/definitions/CodeableConcept" - }, - "detailQuantity": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "$ref": "#/definitions/Quantity" - }, - "detailRange": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "$ref": "#/definitions/Range" - }, - "detailCodeableConcept": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "$ref": "#/definitions/CodeableConcept" - }, - "detailString": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_detailString": { - "description": "Extensions for detailString", - "$ref": "#/definitions/Element" - }, - "detailBoolean": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_detailBoolean": { - "description": "Extensions for detailBoolean", - "$ref": "#/definitions/Element" - }, - "detailInteger": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_detailInteger": { - "description": "Extensions for detailInteger", - "$ref": "#/definitions/Element" - }, - "detailRatio": { - "description": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", - "$ref": "#/definitions/Ratio" - }, - "dueDate": { - "description": "Indicates either the date or the duration after start by which the goal should be met.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_dueDate": { - "description": "Extensions for dueDate", - "$ref": "#/definitions/Element" - }, - "dueDuration": { - "description": "Indicates either the date or the duration after start by which the goal should be met.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "GraphDefinition": { - "description": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", - "properties": { - "resourceType": { - "description": "This is a GraphDefinition resource", - "const": "GraphDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this graph definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the graph definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the graph definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the graph definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this graph definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "start": { - "description": "The type of FHIR resource at which instances of this graph start.", - "$ref": "#/definitions/code" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "The profile that describes the use of the base resource.", - "$ref": "#/definitions/canonical" - }, - "link": { - "description": "Links this graph makes rules about.", - "items": { - "$ref": "#/definitions/GraphDefinition_Link" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "GraphDefinition_Link": { - "description": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "A FHIR expression that identifies one of FHIR References to other resources.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "sliceName": { - "description": "Which slice (if profiled).", - "$ref": "#/definitions/string" - }, - "_sliceName": { - "description": "Extensions for sliceName", - "$ref": "#/definitions/Element" - }, - "min": { - "description": "Minimum occurrences for this link.", - "$ref": "#/definitions/integer" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "Maximum occurrences for this link.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Information about why this link is of interest in this graph definition.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "Potential target for the link.", - "items": { - "$ref": "#/definitions/GraphDefinition_Target" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "GraphDefinition_Target": { - "description": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of resource this link refers to.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "params": { - "description": "A set of parameters to look up.", - "$ref": "#/definitions/string" - }, - "_params": { - "description": "Extensions for params", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "Profile for the target resource.", - "$ref": "#/definitions/canonical" - }, - "compartment": { - "description": "Compartment Consistency Rules.", - "items": { - "$ref": "#/definitions/GraphDefinition_Compartment" - }, - "type": "array" - }, - "link": { - "description": "Additional links from target resource.", - "items": { - "$ref": "#/definitions/GraphDefinition_Link" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "GraphDefinition_Compartment": { - "description": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "use": { - "description": "Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.", - "enum": [ - "condition", - "requirement" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Identifies the compartment.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "rule": { - "description": "identical | matching | different | no-rule | custom.", - "enum": [ - "identical", - "matching", - "different", - "custom" - ] - }, - "_rule": { - "description": "Extensions for rule", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "Custom rule, as a FHIRPath expression.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Documentation for FHIRPath expression.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Group": { - "description": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn\u0027t an Organization.", - "properties": { - "resourceType": { - "description": "This is a Group resource", - "const": "Group" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique business identifier for this group.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Identifies the broad classification of the kind of resources the group includes.", - "enum": [ - "person", - "animal", - "practitioner", - "device", - "medication", - "substance" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "actual": { - "description": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.", - "$ref": "#/definitions/boolean" - }, - "_actual": { - "description": "Extensions for actual", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "name": { - "description": "A label assigned to the group for human identification and communication.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "quantity": { - "description": "A count of the number of resource instances that are part of the group.", - "$ref": "#/definitions/unsignedInt" - }, - "_quantity": { - "description": "Extensions for quantity", - "$ref": "#/definitions/Element" - }, - "managingEntity": { - "description": "Entity responsible for defining and maintaining Group characteristics and/or registered members.", - "$ref": "#/definitions/Reference" - }, - "characteristic": { - "description": "Identifies traits whose presence r absence is shared by members of the group.", - "items": { - "$ref": "#/definitions/Group_Characteristic" - }, - "type": "array" - }, - "member": { - "description": "Identifies the resource instances that are members of the group.", - "items": { - "$ref": "#/definitions/Group_Member" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Group_Characteristic": { - "description": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn\u0027t an Organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code that identifies the kind of trait being asserted.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCodeableConcept": { - "description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueBoolean": { - "description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueQuantity": { - "description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.", - "$ref": "#/definitions/Range" - }, - "valueReference": { - "description": "The value of the trait that holds (or does not hold - see \u0027exclude\u0027) for members of the group.", - "$ref": "#/definitions/Reference" - }, - "exclude": { - "description": "If true, indicates the characteristic is one that is NOT held by members of the group.", - "$ref": "#/definitions/boolean" - }, - "_exclude": { - "description": "Extensions for exclude", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "Group_Member": { - "description": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn\u0027t an Organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "entity": { - "description": "A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "The period that the member was in the group, if known.", - "$ref": "#/definitions/Period" - }, - "inactive": { - "description": "A flag to indicate that the member is no longer in the group, but previously may have been a member.", - "$ref": "#/definitions/boolean" - }, - "_inactive": { - "description": "Extensions for inactive", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "entity" - ] - }, - "GuidanceResponse": { - "description": "A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.", - "properties": { - "resourceType": { - "description": "This is a GuidanceResponse resource", - "const": "GuidanceResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "requestIdentifier": { - "description": "The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.", - "$ref": "#/definitions/Identifier" - }, - "identifier": { - "description": "Allows a service to provide unique, business identifiers for the response.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "moduleUri": { - "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.", - "pattern": "^\\S*$", - "type": "string" - }, - "_moduleUri": { - "description": "Extensions for moduleUri", - "$ref": "#/definitions/Element" - }, - "moduleCanonical": { - "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.", - "pattern": "^\\S*$", - "type": "string" - }, - "_moduleCanonical": { - "description": "Extensions for moduleCanonical", - "$ref": "#/definitions/Element" - }, - "moduleCodeableConcept": { - "description": "An identifier, CodeableConcept or canonical reference to the guidance that was requested.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.", - "enum": [ - "success", - "data-requested", - "data-required", - "in-progress", - "failure", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "The patient for which the request was processed.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The encounter during which this response was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "Indicates when the guidance response was processed.", - "$ref": "#/definitions/dateTime" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "performer": { - "description": "Provides a reference to the device that performed the guidance.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Describes the reason for the guidance response in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Provides a mechanism to communicate additional information about the response.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "evaluationMessage": { - "description": "Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "outputParameters": { - "description": "The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.", - "$ref": "#/definitions/Reference" - }, - "result": { - "description": "The actions, if any, produced by the evaluation of the artifact.", - "$ref": "#/definitions/Reference" - }, - "dataRequirement": { - "description": "If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.", - "items": { - "$ref": "#/definitions/DataRequirement" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "HealthcareService": { - "description": "The details of a healthcare service available at a location.", - "properties": { - "resourceType": { - "description": "This is a HealthcareService resource", - "const": "HealthcareService" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "External identifiers for this item.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "providedBy": { - "description": "The organization that provides this healthcare service.", - "$ref": "#/definitions/Reference" - }, - "category": { - "description": "Identifies the broad category of service being performed or delivered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "type": { - "description": "The specific type of service that may be delivered or performed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "Collection of specialties handled by the service site. This is more of a medical term.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "location": { - "description": "The location(s) where this healthcare service may be provided.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "name": { - "description": "Further description of the service as it would be presented to a consumer while searching.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "extraDetails": { - "description": "Extra details about the service that can\u0027t be placed in the other fields.", - "$ref": "#/definitions/markdown" - }, - "_extraDetails": { - "description": "Extensions for extraDetails", - "$ref": "#/definitions/Element" - }, - "photo": { - "description": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.", - "$ref": "#/definitions/Attachment" - }, - "telecom": { - "description": "List of contacts related to this specific healthcare service.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "coverageArea": { - "description": "The location(s) that this service is available to (not where the service is provided).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "serviceProvisionCode": { - "description": "The code(s) that detail the conditions under which the healthcare service is available/offered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "eligibility": { - "description": "Does this service have specific eligibility requirements that need to be met in order to use the service?", - "items": { - "$ref": "#/definitions/HealthcareService_Eligibility" - }, - "type": "array" - }, - "program": { - "description": "Programs that this service is applicable to.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "characteristic": { - "description": "Collection of characteristics (attributes).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "communication": { - "description": "Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "referralMethod": { - "description": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "appointmentRequired": { - "description": "Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.", - "$ref": "#/definitions/boolean" - }, - "_appointmentRequired": { - "description": "Extensions for appointmentRequired", - "$ref": "#/definitions/Element" - }, - "availableTime": { - "description": "A collection of times that the Service Site is available.", - "items": { - "$ref": "#/definitions/HealthcareService_AvailableTime" - }, - "type": "array" - }, - "notAvailable": { - "description": "The HealthcareService is not available during this period of time due to the provided reason.", - "items": { - "$ref": "#/definitions/HealthcareService_NotAvailable" - }, - "type": "array" - }, - "availabilityExceptions": { - "description": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.", - "$ref": "#/definitions/string" - }, - "_availabilityExceptions": { - "description": "Extensions for availabilityExceptions", - "$ref": "#/definitions/Element" - }, - "endpoint": { - "description": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "HealthcareService_Eligibility": { - "description": "The details of a healthcare service available at a location.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Coded value for the eligibility.", - "$ref": "#/definitions/CodeableConcept" - }, - "comment": { - "description": "Describes the eligibility conditions for the service.", - "$ref": "#/definitions/markdown" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "HealthcareService_AvailableTime": { - "description": "The details of a healthcare service available at a location.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "daysOfWeek": { - "description": "Indicates which days of the week are available between the start and end Times.", - "items": { - "enum": [ - "mon", - "tue", - "wed", - "thu", - "fri", - "sat", - "sun" - ] - }, - "type": "array" - }, - "_daysOfWeek": { - "description": "Extensions for daysOfWeek", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "allDay": { - "description": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", - "$ref": "#/definitions/boolean" - }, - "_allDay": { - "description": "Extensions for allDay", - "$ref": "#/definitions/Element" - }, - "availableStartTime": { - "description": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", - "$ref": "#/definitions/time" - }, - "_availableStartTime": { - "description": "Extensions for availableStartTime", - "$ref": "#/definitions/Element" - }, - "availableEndTime": { - "description": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", - "$ref": "#/definitions/time" - }, - "_availableEndTime": { - "description": "Extensions for availableEndTime", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "HealthcareService_NotAvailable": { - "description": "The details of a healthcare service available at a location.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "The reason that can be presented to the user as to why this time is not available.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "during": { - "description": "Service is not available (seasonally or for a public holiday) from this date.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "ImagingStudy": { - "description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.", - "properties": { - "resourceType": { - "description": "This is a ImagingStudy resource", - "const": "ImagingStudy" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The current state of the ImagingStudy.", - "enum": [ - "registered", - "available", - "cancelled", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "modality": { - "description": "A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "subject": { - "description": "The subject, typically a patient, of the imaging study.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.", - "$ref": "#/definitions/Reference" - }, - "started": { - "description": "Date and time the study started.", - "$ref": "#/definitions/dateTime" - }, - "_started": { - "description": "Extensions for started", - "$ref": "#/definitions/Element" - }, - "basedOn": { - "description": "A list of the diagnostic requests that resulted in this imaging study being performed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "referrer": { - "description": "The requesting/referring physician.", - "$ref": "#/definitions/Reference" - }, - "interpreter": { - "description": "Who read the study and interpreted the images or other content.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "endpoint": { - "description": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "numberOfSeries": { - "description": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.", - "$ref": "#/definitions/unsignedInt" - }, - "_numberOfSeries": { - "description": "Extensions for numberOfSeries", - "$ref": "#/definitions/Element" - }, - "numberOfInstances": { - "description": "Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", - "$ref": "#/definitions/unsignedInt" - }, - "_numberOfInstances": { - "description": "Extensions for numberOfInstances", - "$ref": "#/definitions/Element" - }, - "procedureReference": { - "description": "The procedure which this ImagingStudy was part of.", - "$ref": "#/definitions/Reference" - }, - "procedureCode": { - "description": "The code for the performed procedure type.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "location": { - "description": "The principal physical location where the ImagingStudy was performed.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Description of clinical condition indicating why the ImagingStudy was requested.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies this Study.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "description": { - "description": "The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "series": { - "description": "Each study has one or more series of images or other content.", - "items": { - "$ref": "#/definitions/ImagingStudy_Series" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "ImagingStudy_Series": { - "description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "uid": { - "description": "The DICOM Series Instance UID for the series.", - "$ref": "#/definitions/id" - }, - "_uid": { - "description": "Extensions for uid", - "$ref": "#/definitions/Element" - }, - "number": { - "description": "The numeric identifier of this series in the study.", - "$ref": "#/definitions/unsignedInt" - }, - "_number": { - "description": "Extensions for number", - "$ref": "#/definitions/Element" - }, - "modality": { - "description": "The modality of this series sequence.", - "$ref": "#/definitions/Coding" - }, - "description": { - "description": "A description of the series.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "numberOfInstances": { - "description": "Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", - "$ref": "#/definitions/unsignedInt" - }, - "_numberOfInstances": { - "description": "Extensions for numberOfInstances", - "$ref": "#/definitions/Element" - }, - "endpoint": { - "description": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.", - "$ref": "#/definitions/Coding" - }, - "laterality": { - "description": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.", - "$ref": "#/definitions/Coding" - }, - "specimen": { - "description": "The specimen imaged, e.g., for whole slide imaging of a biopsy.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "started": { - "description": "The date and time the series was started.", - "$ref": "#/definitions/dateTime" - }, - "_started": { - "description": "Extensions for started", - "$ref": "#/definitions/Element" - }, - "performer": { - "description": "Indicates who or what performed the series and how they were involved.", - "items": { - "$ref": "#/definitions/ImagingStudy_Performer" - }, - "type": "array" - }, - "instance": { - "description": "A single SOP instance within the series, e.g. an image, or presentation state.", - "items": { - "$ref": "#/definitions/ImagingStudy_Instance" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "modality" - ] - }, - "ImagingStudy_Performer": { - "description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Distinguishes the type of involvement of the performer in the series.", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "Indicates who or what performed the series.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "ImagingStudy_Instance": { - "description": "Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "uid": { - "description": "The DICOM SOP Instance UID for this image or other DICOM content.", - "$ref": "#/definitions/id" - }, - "_uid": { - "description": "Extensions for uid", - "$ref": "#/definitions/Element" - }, - "sopClass": { - "description": "DICOM instance type.", - "$ref": "#/definitions/Coding" - }, - "number": { - "description": "The number of instance in the series.", - "$ref": "#/definitions/unsignedInt" - }, - "_number": { - "description": "Extensions for number", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "The description of the instance.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "sopClass" - ] - }, - "Immunization": { - "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", - "properties": { - "resourceType": { - "description": "This is a Immunization resource", - "const": "Immunization" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this immunization record.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the current status of the immunization event.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Indicates the reason the immunization event was not performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "vaccineCode": { - "description": "Vaccine that was administered or was to be administered.", - "$ref": "#/definitions/CodeableConcept" - }, - "patient": { - "description": "The patient who either received or did not receive the immunization.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "Date vaccine administered or was to be administered.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrenceString": { - "description": "Date vaccine administered or was to be administered.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_occurrenceString": { - "description": "Extensions for occurrenceString", - "$ref": "#/definitions/Element" - }, - "recorded": { - "description": "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.", - "$ref": "#/definitions/dateTime" - }, - "_recorded": { - "description": "Extensions for recorded", - "$ref": "#/definitions/Element" - }, - "primarySource": { - "description": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.", - "$ref": "#/definitions/boolean" - }, - "_primarySource": { - "description": "Extensions for primarySource", - "$ref": "#/definitions/Element" - }, - "reportOrigin": { - "description": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.", - "$ref": "#/definitions/CodeableConcept" - }, - "location": { - "description": "The service delivery location where the vaccine administration occurred.", - "$ref": "#/definitions/Reference" - }, - "manufacturer": { - "description": "Name of vaccine manufacturer.", - "$ref": "#/definitions/Reference" - }, - "lotNumber": { - "description": "Lot number of the vaccine product.", - "$ref": "#/definitions/string" - }, - "_lotNumber": { - "description": "Extensions for lotNumber", - "$ref": "#/definitions/Element" - }, - "expirationDate": { - "description": "Date vaccine batch expires.", - "$ref": "#/definitions/date" - }, - "_expirationDate": { - "description": "Extensions for expirationDate", - "$ref": "#/definitions/Element" - }, - "site": { - "description": "Body site where vaccine was administered.", - "$ref": "#/definitions/CodeableConcept" - }, - "route": { - "description": "The path by which the vaccine product is taken into the body.", - "$ref": "#/definitions/CodeableConcept" - }, - "doseQuantity": { - "description": "The quantity of vaccine product that was administered.", - "$ref": "#/definitions/Quantity" - }, - "performer": { - "description": "Indicates who performed the immunization event.", - "items": { - "$ref": "#/definitions/Immunization_Performer" - }, - "type": "array" - }, - "note": { - "description": "Extra information about the immunization that is not conveyed by the other attributes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "reasonCode": { - "description": "Reasons why the vaccine was administered.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Condition, Observation or DiagnosticReport that supports why the immunization was administered.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "isSubpotent": { - "description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.", - "$ref": "#/definitions/boolean" - }, - "_isSubpotent": { - "description": "Extensions for isSubpotent", - "$ref": "#/definitions/Element" - }, - "subpotentReason": { - "description": "Reason why a dose is considered to be subpotent.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "education": { - "description": "Educational material presented to the patient (or guardian) at the time of vaccine administration.", - "items": { - "$ref": "#/definitions/Immunization_Education" - }, - "type": "array" - }, - "programEligibility": { - "description": "Indicates a patient\u0027s eligibility for a funding program.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "fundingSource": { - "description": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).", - "$ref": "#/definitions/CodeableConcept" - }, - "reaction": { - "description": "Categorical data indicating that an adverse event is associated in time to an immunization.", - "items": { - "$ref": "#/definitions/Immunization_Reaction" - }, - "type": "array" - }, - "protocolApplied": { - "description": "The protocol (set of recommendations) being followed by the provider who administered the dose.", - "items": { - "$ref": "#/definitions/Immunization_ProtocolApplied" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "vaccineCode", - "resourceType" - ] - }, - "Immunization_Performer": { - "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "The practitioner or organization who performed the action.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "Immunization_Education": { - "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "documentType": { - "description": "Identifier of the material presented to the patient.", - "$ref": "#/definitions/string" - }, - "_documentType": { - "description": "Extensions for documentType", - "$ref": "#/definitions/Element" - }, - "reference": { - "description": "Reference pointer to the educational material given to the patient if the information was on line.", - "$ref": "#/definitions/uri" - }, - "_reference": { - "description": "Extensions for reference", - "$ref": "#/definitions/Element" - }, - "publicationDate": { - "description": "Date the educational material was published.", - "$ref": "#/definitions/dateTime" - }, - "_publicationDate": { - "description": "Extensions for publicationDate", - "$ref": "#/definitions/Element" - }, - "presentationDate": { - "description": "Date the educational material was given to the patient.", - "$ref": "#/definitions/dateTime" - }, - "_presentationDate": { - "description": "Extensions for presentationDate", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Immunization_Reaction": { - "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "date": { - "description": "Date of reaction to the immunization.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "detail": { - "description": "Details of the reaction.", - "$ref": "#/definitions/Reference" - }, - "reported": { - "description": "Self-reported indicator.", - "$ref": "#/definitions/boolean" - }, - "_reported": { - "description": "Extensions for reported", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Immunization_ProtocolApplied": { - "description": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "series": { - "description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", - "$ref": "#/definitions/string" - }, - "_series": { - "description": "Extensions for series", - "$ref": "#/definitions/Element" - }, - "authority": { - "description": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.", - "$ref": "#/definitions/Reference" - }, - "targetDisease": { - "description": "The vaccine preventable disease the dose is being administered against.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "doseNumberPositiveInt": { - "description": "Nominal position in a series.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_doseNumberPositiveInt": { - "description": "Extensions for doseNumberPositiveInt", - "$ref": "#/definitions/Element" - }, - "doseNumberString": { - "description": "Nominal position in a series.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_doseNumberString": { - "description": "Extensions for doseNumberString", - "$ref": "#/definitions/Element" - }, - "seriesDosesPositiveInt": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_seriesDosesPositiveInt": { - "description": "Extensions for seriesDosesPositiveInt", - "$ref": "#/definitions/Element" - }, - "seriesDosesString": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_seriesDosesString": { - "description": "Extensions for seriesDosesString", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ImmunizationEvaluation": { - "description": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those recommendations.", - "properties": { - "resourceType": { - "description": "This is a ImmunizationEvaluation resource", - "const": "ImmunizationEvaluation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this immunization evaluation record.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the current status of the evaluation of the vaccination administration event.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The individual for whom the evaluation is being done.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date the evaluation of the vaccine administration event was performed.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "authority": { - "description": "Indicates the authority who published the protocol (e.g. ACIP).", - "$ref": "#/definitions/Reference" - }, - "targetDisease": { - "description": "The vaccine preventable disease the dose is being evaluated against.", - "$ref": "#/definitions/CodeableConcept" - }, - "immunizationEvent": { - "description": "The vaccine administration event being evaluated.", - "$ref": "#/definitions/Reference" - }, - "doseStatus": { - "description": "Indicates if the dose is valid or not valid with respect to the published recommendations.", - "$ref": "#/definitions/CodeableConcept" - }, - "doseStatusReason": { - "description": "Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "Additional information about the evaluation.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "series": { - "description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", - "$ref": "#/definitions/string" - }, - "_series": { - "description": "Extensions for series", - "$ref": "#/definitions/Element" - }, - "doseNumberPositiveInt": { - "description": "Nominal position in a series.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_doseNumberPositiveInt": { - "description": "Extensions for doseNumberPositiveInt", - "$ref": "#/definitions/Element" - }, - "doseNumberString": { - "description": "Nominal position in a series.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_doseNumberString": { - "description": "Extensions for doseNumberString", - "$ref": "#/definitions/Element" - }, - "seriesDosesPositiveInt": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_seriesDosesPositiveInt": { - "description": "Extensions for seriesDosesPositiveInt", - "$ref": "#/definitions/Element" - }, - "seriesDosesString": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_seriesDosesString": { - "description": "Extensions for seriesDosesString", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "doseStatus", - "patient", - "targetDisease", - "immunizationEvent", - "resourceType" - ] - }, - "ImmunizationRecommendation": { - "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.", - "properties": { - "resourceType": { - "description": "This is a ImmunizationRecommendation resource", - "const": "ImmunizationRecommendation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this particular recommendation record.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "patient": { - "description": "The patient the recommendation(s) are for.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date the immunization recommendation(s) were created.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "authority": { - "description": "Indicates the authority who published the protocol (e.g. ACIP).", - "$ref": "#/definitions/Reference" - }, - "recommendation": { - "description": "Vaccine administration recommendations.", - "items": { - "$ref": "#/definitions/ImmunizationRecommendation_Recommendation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "recommendation", - "resourceType" - ] - }, - "ImmunizationRecommendation_Recommendation": { - "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "vaccineCode": { - "description": "Vaccine(s) or vaccine group that pertain to the recommendation.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "targetDisease": { - "description": "The targeted disease for the recommendation.", - "$ref": "#/definitions/CodeableConcept" - }, - "contraindicatedVaccineCode": { - "description": "Vaccine(s) which should not be used to fulfill the recommendation.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "forecastStatus": { - "description": "Indicates the patient status with respect to the path to immunity for the target disease.", - "$ref": "#/definitions/CodeableConcept" - }, - "forecastReason": { - "description": "The reason for the assigned forecast status.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "dateCriterion": { - "description": "Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.", - "items": { - "$ref": "#/definitions/ImmunizationRecommendation_DateCriterion" - }, - "type": "array" - }, - "description": { - "description": "Contains the description about the protocol under which the vaccine was administered.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "series": { - "description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", - "$ref": "#/definitions/string" - }, - "_series": { - "description": "Extensions for series", - "$ref": "#/definitions/Element" - }, - "doseNumberPositiveInt": { - "description": "Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_doseNumberPositiveInt": { - "description": "Extensions for doseNumberPositiveInt", - "$ref": "#/definitions/Element" - }, - "doseNumberString": { - "description": "Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_doseNumberString": { - "description": "Extensions for doseNumberString", - "$ref": "#/definitions/Element" - }, - "seriesDosesPositiveInt": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_seriesDosesPositiveInt": { - "description": "Extensions for seriesDosesPositiveInt", - "$ref": "#/definitions/Element" - }, - "seriesDosesString": { - "description": "The recommended number of doses to achieve immunity.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_seriesDosesString": { - "description": "Extensions for seriesDosesString", - "$ref": "#/definitions/Element" - }, - "supportingImmunization": { - "description": "Immunization event history and/or evaluation that supports the status and recommendation.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "supportingPatientInformation": { - "description": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "forecastStatus" - ] - }, - "ImmunizationRecommendation_DateCriterion": { - "description": "A patient\u0027s point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Date classification of recommendation. For example, earliest date to give, latest date to give, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "The date whose meaning is specified by dateCriterion.code.", - "$ref": "#/definitions/dateTime" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "ImplementationGuide": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "resourceType": { - "description": "This is a ImplementationGuide resource", - "const": "ImplementationGuide" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the implementation guide.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this implementation guide. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the implementation guide.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the implementation guide from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the implementation guide is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "packageId": { - "description": "The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.", - "$ref": "#/definitions/id" - }, - "_packageId": { - "description": "Extensions for packageId", - "$ref": "#/definitions/Element" - }, - "license": { - "description": "The license that applies to this Implementation Guide, using an SPDX license code, or \u0027not-open-source\u0027.", - "enum": [ - "not-open-source", - "0BSD", - "AAL", - "Abstyles", - "Adobe-2006", - "Adobe-Glyph", - "ADSL", - "AFL-1.1", - "AFL-1.2", - "AFL-2.0", - "AFL-2.1", - "AFL-3.0", - "Afmparse", - "AGPL-1.0-only", - "AGPL-1.0-or-later", - "AGPL-3.0-only", - "AGPL-3.0-or-later", - "Aladdin", - "AMDPLPA", - "AML", - "AMPAS", - "ANTLR-PD", - "Apache-1.0", - "Apache-1.1", - "Apache-2.0", - "APAFML", - "APL-1.0", - "APSL-1.0", - "APSL-1.1", - "APSL-1.2", - "APSL-2.0", - "Artistic-1.0-cl8", - "Artistic-1.0-Perl", - "Artistic-1.0", - "Artistic-2.0", - "Bahyph", - "Barr", - "Beerware", - "BitTorrent-1.0", - "BitTorrent-1.1", - "Borceux", - "BSD-1-Clause", - "BSD-2-Clause-FreeBSD", - "BSD-2-Clause-NetBSD", - "BSD-2-Clause-Patent", - "BSD-2-Clause", - "BSD-3-Clause-Attribution", - "BSD-3-Clause-Clear", - "BSD-3-Clause-LBNL", - "BSD-3-Clause-No-Nuclear-License-2014", - "BSD-3-Clause-No-Nuclear-License", - "BSD-3-Clause-No-Nuclear-Warranty", - "BSD-3-Clause", - "BSD-4-Clause-UC", - "BSD-4-Clause", - "BSD-Protection", - "BSD-Source-Code", - "BSL-1.0", - "bzip2-1.0.5", - "bzip2-1.0.6", - "Caldera", - "CATOSL-1.1", - "CC-BY-1.0", - "CC-BY-2.0", - "CC-BY-2.5", - "CC-BY-3.0", - "CC-BY-4.0", - "CC-BY-NC-1.0", - "CC-BY-NC-2.0", - "CC-BY-NC-2.5", - "CC-BY-NC-3.0", - "CC-BY-NC-4.0", - "CC-BY-NC-ND-1.0", - "CC-BY-NC-ND-2.0", - "CC-BY-NC-ND-2.5", - "CC-BY-NC-ND-3.0", - "CC-BY-NC-ND-4.0", - "CC-BY-NC-SA-1.0", - "CC-BY-NC-SA-2.0", - "CC-BY-NC-SA-2.5", - "CC-BY-NC-SA-3.0", - "CC-BY-NC-SA-4.0", - "CC-BY-ND-1.0", - "CC-BY-ND-2.0", - "CC-BY-ND-2.5", - "CC-BY-ND-3.0", - "CC-BY-ND-4.0", - "CC-BY-SA-1.0", - "CC-BY-SA-2.0", - "CC-BY-SA-2.5", - "CC-BY-SA-3.0", - "CC-BY-SA-4.0", - "CC0-1.0", - "CDDL-1.0", - "CDDL-1.1", - "CDLA-Permissive-1.0", - "CDLA-Sharing-1.0", - "CECILL-1.0", - "CECILL-1.1", - "CECILL-2.0", - "CECILL-2.1", - "CECILL-B", - "CECILL-C", - "ClArtistic", - "CNRI-Jython", - "CNRI-Python-GPL-Compatible", - "CNRI-Python", - "Condor-1.1", - "CPAL-1.0", - "CPL-1.0", - "CPOL-1.02", - "Crossword", - "CrystalStacker", - "CUA-OPL-1.0", - "Cube", - "curl", - "D-FSL-1.0", - "diffmark", - "DOC", - "Dotseqn", - "DSDP", - "dvipdfm", - "ECL-1.0", - "ECL-2.0", - "EFL-1.0", - "EFL-2.0", - "eGenix", - "Entessa", - "EPL-1.0", - "EPL-2.0", - "ErlPL-1.1", - "EUDatagrid", - "EUPL-1.0", - "EUPL-1.1", - "EUPL-1.2", - "Eurosym", - "Fair", - "Frameworx-1.0", - "FreeImage", - "FSFAP", - "FSFUL", - "FSFULLR", - "FTL", - "GFDL-1.1-only", - "GFDL-1.1-or-later", - "GFDL-1.2-only", - "GFDL-1.2-or-later", - "GFDL-1.3-only", - "GFDL-1.3-or-later", - "Giftware", - "GL2PS", - "Glide", - "Glulxe", - "gnuplot", - "GPL-1.0-only", - "GPL-1.0-or-later", - "GPL-2.0-only", - "GPL-2.0-or-later", - "GPL-3.0-only", - "GPL-3.0-or-later", - "gSOAP-1.3b", - "HaskellReport", - "HPND", - "IBM-pibs", - "ICU", - "IJG", - "ImageMagick", - "iMatix", - "Imlib2", - "Info-ZIP", - "Intel-ACPI", - "Intel", - "Interbase-1.0", - "IPA", - "IPL-1.0", - "ISC", - "JasPer-2.0", - "JSON", - "LAL-1.2", - "LAL-1.3", - "Latex2e", - "Leptonica", - "LGPL-2.0-only", - "LGPL-2.0-or-later", - "LGPL-2.1-only", - "LGPL-2.1-or-later", - "LGPL-3.0-only", - "LGPL-3.0-or-later", - "LGPLLR", - "Libpng", - "libtiff", - "LiLiQ-P-1.1", - "LiLiQ-R-1.1", - "LiLiQ-Rplus-1.1", - "Linux-OpenIB", - "LPL-1.0", - "LPL-1.02", - "LPPL-1.0", - "LPPL-1.1", - "LPPL-1.2", - "LPPL-1.3a", - "LPPL-1.3c", - "MakeIndex", - "MirOS", - "MIT-0", - "MIT-advertising", - "MIT-CMU", - "MIT-enna", - "MIT-feh", - "MIT", - "MITNFA", - "Motosoto", - "mpich2", - "MPL-1.0", - "MPL-1.1", - "MPL-2.0-no-copyleft-exception", - "MPL-2.0", - "MS-PL", - "MS-RL", - "MTLL", - "Multics", - "Mup", - "NASA-1.3", - "Naumen", - "NBPL-1.0", - "NCSA", - "Net-SNMP", - "NetCDF", - "Newsletr", - "NGPL", - "NLOD-1.0", - "NLPL", - "Nokia", - "NOSL", - "Noweb", - "NPL-1.0", - "NPL-1.1", - "NPOSL-3.0", - "NRL", - "NTP", - "OCCT-PL", - "OCLC-2.0", - "ODbL-1.0", - "OFL-1.0", - "OFL-1.1", - "OGTSL", - "OLDAP-1.1", - "OLDAP-1.2", - "OLDAP-1.3", - "OLDAP-1.4", - "OLDAP-2.0.1", - "OLDAP-2.0", - "OLDAP-2.1", - "OLDAP-2.2.1", - "OLDAP-2.2.2", - "OLDAP-2.2", - "OLDAP-2.3", - "OLDAP-2.4", - "OLDAP-2.5", - "OLDAP-2.6", - "OLDAP-2.7", - "OLDAP-2.8", - "OML", - "OpenSSL", - "OPL-1.0", - "OSET-PL-2.1", - "OSL-1.0", - "OSL-1.1", - "OSL-2.0", - "OSL-2.1", - "OSL-3.0", - "PDDL-1.0", - "PHP-3.0", - "PHP-3.01", - "Plexus", - "PostgreSQL", - "psfrag", - "psutils", - "Python-2.0", - "Qhull", - "QPL-1.0", - "Rdisc", - "RHeCos-1.1", - "RPL-1.1", - "RPL-1.5", - "RPSL-1.0", - "RSA-MD", - "RSCPL", - "Ruby", - "SAX-PD", - "Saxpath", - "SCEA", - "Sendmail", - "SGI-B-1.0", - "SGI-B-1.1", - "SGI-B-2.0", - "SimPL-2.0", - "SISSL-1.2", - "SISSL", - "Sleepycat", - "SMLNJ", - "SMPPL", - "SNIA", - "Spencer-86", - "Spencer-94", - "Spencer-99", - "SPL-1.0", - "SugarCRM-1.1.3", - "SWL", - "TCL", - "TCP-wrappers", - "TMate", - "TORQUE-1.1", - "TOSL", - "Unicode-DFS-2015", - "Unicode-DFS-2016", - "Unicode-TOU", - "Unlicense", - "UPL-1.0", - "Vim", - "VOSTROM", - "VSL-1.0", - "W3C-19980720", - "W3C-20150513", - "W3C", - "Watcom-1.0", - "Wsuipa", - "WTFPL", - "X11", - "Xerox", - "XFree86-1.1", - "xinetd", - "Xnet", - "xpp", - "XSkat", - "YPL-1.0", - "YPL-1.1", - "Zed", - "Zend-2.0", - "Zimbra-1.3", - "Zimbra-1.4", - "zlib-acknowledgement", - "Zlib", - "ZPL-1.1", - "ZPL-2.0", - "ZPL-2.1" - ] - }, - "_license": { - "description": "Extensions for license", - "$ref": "#/definitions/Element" - }, - "fhirVersion": { - "description": "The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.", - "items": { - "enum": [ - "0.01", - "0.05", - "0.06", - "0.11", - "0.0.80", - "0.0.81", - "0.0.82", - "0.4.0", - "0.5.0", - "1.0.0", - "1.0.1", - "1.0.2", - "1.1.0", - "1.4.0", - "1.6.0", - "1.8.0", - "3.0.0", - "3.0.1", - "3.3.0", - "3.5.0", - "4.0.0", - "4.0.1" - ] - }, - "type": "array" - }, - "_fhirVersion": { - "description": "Extensions for fhirVersion", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "dependsOn": { - "description": "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.", - "items": { - "$ref": "#/definitions/ImplementationGuide_DependsOn" - }, - "type": "array" - }, - "global": { - "description": "A set of profiles that all resources covered by this implementation guide must conform to.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Global" - }, - "type": "array" - }, - "definition": { - "description": "The information needed by an IG publisher tool to publish the whole implementation guide.", - "$ref": "#/definitions/ImplementationGuide_Definition" - }, - "manifest": { - "description": "Information about an assembled implementation guide, created by the publication tooling.", - "$ref": "#/definitions/ImplementationGuide_Manifest" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ImplementationGuide_DependsOn": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "uri": { - "description": "A canonical reference to the Implementation guide for the dependency.", - "$ref": "#/definitions/canonical" - }, - "packageId": { - "description": "The NPM package name for the Implementation Guide that this IG depends on.", - "$ref": "#/definitions/id" - }, - "_packageId": { - "description": "Extensions for packageId", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version of the IG that is depended on, when the correct version is required to understand the IG correctly.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "uri" - ] - }, - "ImplementationGuide_Global": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of resource that all instances must conform to.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A reference to the profile that all instances must conform to.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "profile" - ] - }, - "ImplementationGuide_Definition": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "grouping": { - "description": "A logical group of resources. Logical groups can be used when building pages.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Grouping" - }, - "type": "array" - }, - "resource": { - "description": "A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Resource" - }, - "type": "array" - }, - "page": { - "description": "A page / section in the implementation guide. The root page is the implementation guide home page.", - "$ref": "#/definitions/ImplementationGuide_Page" - }, - "parameter": { - "description": "Defines how IG is built by tools.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Parameter" - }, - "type": "array" - }, - "template": { - "description": "A template for building resources.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Template" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resource" - ] - }, - "ImplementationGuide_Grouping": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The human-readable title to display for the package of resources when rendering the implementation guide.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Human readable text describing the package.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ImplementationGuide_Resource": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "Where this resource is found.", - "$ref": "#/definitions/Reference" - }, - "fhirVersion": { - "description": "Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.", - "items": { - "enum": [ - "0.01", - "0.05", - "0.06", - "0.11", - "0.0.80", - "0.0.81", - "0.0.82", - "0.4.0", - "0.5.0", - "1.0.0", - "1.0.1", - "1.0.2", - "1.1.0", - "1.4.0", - "1.6.0", - "1.8.0", - "3.0.0", - "3.0.1", - "3.3.0", - "3.5.0", - "4.0.0", - "4.0.1" - ] - }, - "type": "array" - }, - "_fhirVersion": { - "description": "Extensions for fhirVersion", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "name": { - "description": "A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A description of the reason that a resource has been included in the implementation guide.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "exampleBoolean": { - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_exampleBoolean": { - "description": "Extensions for exampleBoolean", - "$ref": "#/definitions/Element" - }, - "exampleCanonical": { - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", - "pattern": "^\\S*$", - "type": "string" - }, - "_exampleCanonical": { - "description": "Extensions for exampleCanonical", - "$ref": "#/definitions/Element" - }, - "groupingId": { - "description": "Reference to the id of the grouping this resource appears in.", - "$ref": "#/definitions/id" - }, - "_groupingId": { - "description": "Extensions for groupingId", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "reference" - ] - }, - "ImplementationGuide_Page": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "nameUrl": { - "description": "The source address for the page.", - "pattern": "^\\S*$", - "type": "string" - }, - "_nameUrl": { - "description": "Extensions for nameUrl", - "$ref": "#/definitions/Element" - }, - "nameReference": { - "description": "The source address for the page.", - "$ref": "#/definitions/Reference" - }, - "title": { - "description": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "generation": { - "description": "A code that indicates how the page is generated.", - "enum": [ - "html", - "markdown", - "xml", - "generated" - ] - }, - "_generation": { - "description": "Extensions for generation", - "$ref": "#/definitions/Element" - }, - "page": { - "description": "Nested Pages/Sections under this page.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Page" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ImplementationGuide_Parameter": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.", - "enum": [ - "apply", - "path-resource", - "path-pages", - "path-tx-cache", - "expansion-parameter", - "rule-broken-links", - "generate-xml", - "generate-json", - "generate-turtle", - "html-template" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "Value for named type.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ImplementationGuide_Template": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Type of template specified.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "The source location for the template.", - "$ref": "#/definitions/string" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "scope": { - "description": "The scope in which the template applies.", - "$ref": "#/definitions/string" - }, - "_scope": { - "description": "Extensions for scope", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ImplementationGuide_Manifest": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "rendering": { - "description": "A pointer to official web page, PDF or other rendering of the implementation guide.", - "$ref": "#/definitions/url" - }, - "_rendering": { - "description": "Extensions for rendering", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Resource1" - }, - "type": "array" - }, - "page": { - "description": "Information about a page within the IG.", - "items": { - "$ref": "#/definitions/ImplementationGuide_Page1" - }, - "type": "array" - }, - "image": { - "description": "Indicates a relative path to an image that exists within the IG.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_image": { - "description": "Extensions for image", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "other": { - "description": "Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_other": { - "description": "Extensions for other", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resource" - ] - }, - "ImplementationGuide_Resource1": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "reference": { - "description": "Where this resource is found.", - "$ref": "#/definitions/Reference" - }, - "exampleBoolean": { - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_exampleBoolean": { - "description": "Extensions for exampleBoolean", - "$ref": "#/definitions/Element" - }, - "exampleCanonical": { - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", - "pattern": "^\\S*$", - "type": "string" - }, - "_exampleCanonical": { - "description": "Extensions for exampleCanonical", - "$ref": "#/definitions/Element" - }, - "relativePath": { - "description": "The relative path for primary page for this resource within the IG.", - "$ref": "#/definitions/url" - }, - "_relativePath": { - "description": "Extensions for relativePath", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "reference" - ] - }, - "ImplementationGuide_Page1": { - "description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Relative path to the page.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "Label for the page intended for human display.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "anchor": { - "description": "The name of an anchor available on the page.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_anchor": { - "description": "Extensions for anchor", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "InsurancePlan": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "resourceType": { - "description": "This is a InsurancePlan resource", - "const": "InsurancePlan" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The current state of the health insurance product.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind of health insurance product.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "name": { - "description": "Official name of the health insurance product as designated by the owner.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "A list of alternate names that the product is known as, or was known as in the past.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_alias": { - "description": "Extensions for alias", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "period": { - "description": "The period of time that the health insurance product is available.", - "$ref": "#/definitions/Period" - }, - "ownedBy": { - "description": "The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as \u0027payers\u0027.", - "$ref": "#/definitions/Reference" - }, - "administeredBy": { - "description": "An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.", - "$ref": "#/definitions/Reference" - }, - "coverageArea": { - "description": "The geographic region in which a health insurance product\u0027s benefits apply.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "contact": { - "description": "The contact for the health insurance product for a certain purpose.", - "items": { - "$ref": "#/definitions/InsurancePlan_Contact" - }, - "type": "array" - }, - "endpoint": { - "description": "The technical endpoints providing access to services operated for the health insurance product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "network": { - "description": "Reference to the network included in the health insurance product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "coverage": { - "description": "Details about the coverage offered by the insurance product.", - "items": { - "$ref": "#/definitions/InsurancePlan_Coverage" - }, - "type": "array" - }, - "plan": { - "description": "Details about an insurance plan.", - "items": { - "$ref": "#/definitions/InsurancePlan_Plan" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "InsurancePlan_Contact": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "purpose": { - "description": "Indicates a purpose for which the contact can be reached.", - "$ref": "#/definitions/CodeableConcept" - }, - "name": { - "description": "A name associated with the contact.", - "$ref": "#/definitions/HumanName" - }, - "telecom": { - "description": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "Visiting or postal addresses for the contact.", - "$ref": "#/definitions/Address" - } - }, - "additionalProperties": false - }, - "InsurancePlan_Coverage": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health).", - "$ref": "#/definitions/CodeableConcept" - }, - "network": { - "description": "Reference to the network that providing the type of coverage.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "benefit": { - "description": "Specific benefits under this type of coverage.", - "items": { - "$ref": "#/definitions/InsurancePlan_Benefit" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type", - "benefit" - ] - }, - "InsurancePlan_Benefit": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of benefit (primary care; speciality care; inpatient; outpatient).", - "$ref": "#/definitions/CodeableConcept" - }, - "requirement": { - "description": "The referral requirements to have access/coverage for this benefit.", - "$ref": "#/definitions/string" - }, - "_requirement": { - "description": "Extensions for requirement", - "$ref": "#/definitions/Element" - }, - "limit": { - "description": "The specific limits on the benefit.", - "items": { - "$ref": "#/definitions/InsurancePlan_Limit" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "InsurancePlan_Limit": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses.", - "$ref": "#/definitions/Quantity" - }, - "code": { - "description": "The specific limit on the benefit.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "InsurancePlan_Plan": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "Type of plan. For example, \"Platinum\" or \"High Deductable\".", - "$ref": "#/definitions/CodeableConcept" - }, - "coverageArea": { - "description": "The geographic region in which a health insurance plan\u0027s benefits apply.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "network": { - "description": "Reference to the network that providing the type of coverage.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "generalCost": { - "description": "Overall costs associated with the plan.", - "items": { - "$ref": "#/definitions/InsurancePlan_GeneralCost" - }, - "type": "array" - }, - "specificCost": { - "description": "Costs associated with the coverage provided by the product.", - "items": { - "$ref": "#/definitions/InsurancePlan_SpecificCost" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "InsurancePlan_GeneralCost": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of cost.", - "$ref": "#/definitions/CodeableConcept" - }, - "groupSize": { - "description": "Number of participants enrolled in the plan.", - "$ref": "#/definitions/positiveInt" - }, - "_groupSize": { - "description": "Extensions for groupSize", - "$ref": "#/definitions/Element" - }, - "cost": { - "description": "Value of the cost.", - "$ref": "#/definitions/Money" - }, - "comment": { - "description": "Additional information about the general costs associated with this plan.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "InsurancePlan_SpecificCost": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health).", - "$ref": "#/definitions/CodeableConcept" - }, - "benefit": { - "description": "List of the specific benefits under this category of benefit.", - "items": { - "$ref": "#/definitions/InsurancePlan_Benefit1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "category" - ] - }, - "InsurancePlan_Benefit1": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of specific benefit (preventative; primary care office visit; speciality office visit; hospitalization; emergency room; urgent care).", - "$ref": "#/definitions/CodeableConcept" - }, - "cost": { - "description": "List of the costs associated with a specific benefit.", - "items": { - "$ref": "#/definitions/InsurancePlan_Cost" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "InsurancePlan_Cost": { - "description": "Details of a Health Insurance product/plan provided by an organization.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of cost (copay; individual cap; family cap; coinsurance; deductible).", - "$ref": "#/definitions/CodeableConcept" - }, - "applicability": { - "description": "Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other).", - "$ref": "#/definitions/CodeableConcept" - }, - "qualifiers": { - "description": "Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "value": { - "description": "The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance).", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "Invoice": { - "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.", - "properties": { - "resourceType": { - "description": "This is a Invoice resource", - "const": "Invoice" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The current state of the Invoice.", - "enum": [ - "draft", - "issued", - "balanced", - "cancelled", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "cancelledReason": { - "description": "In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).", - "$ref": "#/definitions/string" - }, - "_cancelledReason": { - "description": "Extensions for cancelledReason", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The individual or set of individuals receiving the goods and services billed in this invoice.", - "$ref": "#/definitions/Reference" - }, - "recipient": { - "description": "The individual or Organization responsible for balancing of this invoice.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "Date/time(s) of when this Invoice was posted.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "participant": { - "description": "Indicates who or what performed or participated in the charged service.", - "items": { - "$ref": "#/definitions/Invoice_Participant" - }, - "type": "array" - }, - "issuer": { - "description": "The organizationissuing the Invoice.", - "$ref": "#/definitions/Reference" - }, - "account": { - "description": "Account which is supposed to be balanced with this Invoice.", - "$ref": "#/definitions/Reference" - }, - "lineItem": { - "description": "Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.", - "items": { - "$ref": "#/definitions/Invoice_LineItem" - }, - "type": "array" - }, - "totalPriceComponent": { - "description": "The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.", - "items": { - "$ref": "#/definitions/Invoice_PriceComponent" - }, - "type": "array" - }, - "totalNet": { - "description": "Invoice total , taxes excluded.", - "$ref": "#/definitions/Money" - }, - "totalGross": { - "description": "Invoice total, tax included.", - "$ref": "#/definitions/Money" - }, - "paymentTerms": { - "description": "Payment details such as banking details, period of payment, deductibles, methods of payment.", - "$ref": "#/definitions/markdown" - }, - "_paymentTerms": { - "description": "Extensions for paymentTerms", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Comments made about the invoice by the issuer, subject, or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Invoice_Participant": { - "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "role": { - "description": "Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "The device, practitioner, etc. who performed or participated in the service.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "Invoice_LineItem": { - "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequence": { - "description": "Sequence in which the items appear on the invoice.", - "$ref": "#/definitions/positiveInt" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "chargeItemReference": { - "description": "The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.", - "$ref": "#/definitions/Reference" - }, - "chargeItemCodeableConcept": { - "description": "The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.", - "$ref": "#/definitions/CodeableConcept" - }, - "priceComponent": { - "description": "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.", - "items": { - "$ref": "#/definitions/Invoice_PriceComponent" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Invoice_PriceComponent": { - "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "This code identifies the type of the component.", - "enum": [ - "base", - "surcharge", - "deduction", - "discount", - "tax", - "informational" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "factor": { - "description": "The factor that has been applied on the base price for calculating this component.", - "$ref": "#/definitions/decimal" - }, - "_factor": { - "description": "Extensions for factor", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "The amount calculated for this component.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false - }, - "Library": { - "description": "The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.", - "properties": { - "resourceType": { - "description": "This is a Library resource", - "const": "Library" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the library.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the library giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this library. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectCodeableConcept": { - "description": "A code or group definition that describes the intended subject of the contents of the library.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "A code or group definition that describes the intended subject of the contents of the library.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the library.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the library from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the library is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this library is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description of how the library is used from a clinical perspective.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the library content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "parameter": { - "description": "The parameter element defines parameters used by the library.", - "items": { - "$ref": "#/definitions/ParameterDefinition" - }, - "type": "array" - }, - "dataRequirement": { - "description": "Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.", - "items": { - "$ref": "#/definitions/DataRequirement" - }, - "type": "array" - }, - "content": { - "description": "The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type", - "resourceType" - ] - }, - "Linkage": { - "description": "Identifies two or more records (resource instances) that refer to the same real-world \"occurrence\".", - "properties": { - "resourceType": { - "description": "This is a Linkage resource", - "const": "Linkage" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "active": { - "description": "Indicates whether the asserted set of linkages are considered to be \"in effect\".", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.", - "$ref": "#/definitions/Reference" - }, - "item": { - "description": "Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.", - "items": { - "$ref": "#/definitions/Linkage_Item" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "item", - "resourceType" - ] - }, - "Linkage_Item": { - "description": "Identifies two or more records (resource instances) that refer to the same real-world \"occurrence\".", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Distinguishes which item is \"source of truth\" (if any) and which items are no longer considered to be current representations.", - "enum": [ - "source", - "alternate", - "historical" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "The resource instance being linked as part of the group.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resource" - ] - }, - "List": { - "description": "A list is a curated collection of resources.", - "properties": { - "resourceType": { - "description": "This is a List resource", - "const": "List" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the List assigned for business purposes outside the context of FHIR.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Indicates the current state of this list.", - "enum": [ - "current", - "retired", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "mode": { - "description": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", - "enum": [ - "working", - "snapshot", - "changes" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A label for the list assigned by the author.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "This code defines the purpose of the list - why it was created.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The common subject (or patient) of the resources that are in the list if there is one.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The encounter that is the context in which this list was created.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date that the list was prepared.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.", - "$ref": "#/definitions/Reference" - }, - "orderedBy": { - "description": "What order applies to the items in the list.", - "$ref": "#/definitions/CodeableConcept" - }, - "note": { - "description": "Comments that apply to the overall list.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "entry": { - "description": "Entries in this list.", - "items": { - "$ref": "#/definitions/List_Entry" - }, - "type": "array" - }, - "emptyReason": { - "description": "If the list is empty, why the list is empty.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "List_Entry": { - "description": "A list is a curated collection of resources.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "flag": { - "description": "The flag allows the system constructing the list to indicate the role and significance of the item in the list.", - "$ref": "#/definitions/CodeableConcept" - }, - "deleted": { - "description": "True if this item is marked as deleted in the list.", - "$ref": "#/definitions/boolean" - }, - "_deleted": { - "description": "Extensions for deleted", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "When this item was added to the list.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "item": { - "description": "A reference to the actual resource from which data was derived.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "item" - ] - }, - "Location": { - "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.", - "properties": { - "resourceType": { - "description": "This is a Location resource", - "const": "Location" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique code or number identifying the location to its users.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.", - "enum": [ - "active", - "suspended", - "inactive" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "operationalStatus": { - "description": "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.", - "$ref": "#/definitions/Coding" - }, - "name": { - "description": "Name of the location as used by humans. Does not need to be unique.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "A list of alternate names that the location is known as, or was known as, in the past.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_alias": { - "description": "Extensions for alias", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "description": { - "description": "Description of the Location, which helps in finding or referencing the place.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "mode": { - "description": "Indicates whether a resource instance represents a specific location or a class of locations.", - "enum": [ - "instance", - "kind" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Indicates the type of function performed at the location.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "telecom": { - "description": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "Physical location.", - "$ref": "#/definitions/Address" - }, - "physicalType": { - "description": "Physical form of the location, e.g. building, room, vehicle, road.", - "$ref": "#/definitions/CodeableConcept" - }, - "position": { - "description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).", - "$ref": "#/definitions/Location_Position" - }, - "managingOrganization": { - "description": "The organization responsible for the provisioning and upkeep of the location.", - "$ref": "#/definitions/Reference" - }, - "partOf": { - "description": "Another Location of which this Location is physically a part of.", - "$ref": "#/definitions/Reference" - }, - "hoursOfOperation": { - "description": "What days/times during a week is this location usually open.", - "items": { - "$ref": "#/definitions/Location_HoursOfOperation" - }, - "type": "array" - }, - "availabilityExceptions": { - "description": "A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.", - "$ref": "#/definitions/string" - }, - "_availabilityExceptions": { - "description": "Extensions for availabilityExceptions", - "$ref": "#/definitions/Element" - }, - "endpoint": { - "description": "Technical endpoints providing access to services operated for the location.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Location_Position": { - "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "longitude": { - "description": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).", - "$ref": "#/definitions/decimal" - }, - "_longitude": { - "description": "Extensions for longitude", - "$ref": "#/definitions/Element" - }, - "latitude": { - "description": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).", - "$ref": "#/definitions/decimal" - }, - "_latitude": { - "description": "Extensions for latitude", - "$ref": "#/definitions/Element" - }, - "altitude": { - "description": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).", - "$ref": "#/definitions/decimal" - }, - "_altitude": { - "description": "Extensions for altitude", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Location_HoursOfOperation": { - "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "daysOfWeek": { - "description": "Indicates which days of the week are available between the start and end Times.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_daysOfWeek": { - "description": "Extensions for daysOfWeek", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "allDay": { - "description": "The Location is open all day.", - "$ref": "#/definitions/boolean" - }, - "_allDay": { - "description": "Extensions for allDay", - "$ref": "#/definitions/Element" - }, - "openingTime": { - "description": "Time that the Location opens.", - "$ref": "#/definitions/time" - }, - "_openingTime": { - "description": "Extensions for openingTime", - "$ref": "#/definitions/Element" - }, - "closingTime": { - "description": "Time that the Location closes.", - "$ref": "#/definitions/time" - }, - "_closingTime": { - "description": "Extensions for closingTime", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Measure": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "resourceType": { - "description": "This is a Measure resource", - "const": "Measure" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the measure.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the measure giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this measure. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the measure was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the measure.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the measure from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the measure is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this measure is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description, from a clinical perspective, of how the measure is used.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the measure content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "library": { - "description": "A reference to a Library resource containing the formal logic used by the measure.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "disclaimer": { - "description": "Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.", - "$ref": "#/definitions/markdown" - }, - "_disclaimer": { - "description": "Extensions for disclaimer", - "$ref": "#/definitions/Element" - }, - "scoring": { - "description": "Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.", - "$ref": "#/definitions/CodeableConcept" - }, - "compositeScoring": { - "description": "If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "riskAdjustment": { - "description": "A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.", - "$ref": "#/definitions/string" - }, - "_riskAdjustment": { - "description": "Extensions for riskAdjustment", - "$ref": "#/definitions/Element" - }, - "rateAggregation": { - "description": "Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.", - "$ref": "#/definitions/string" - }, - "_rateAggregation": { - "description": "Extensions for rateAggregation", - "$ref": "#/definitions/Element" - }, - "rationale": { - "description": "Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.", - "$ref": "#/definitions/markdown" - }, - "_rationale": { - "description": "Extensions for rationale", - "$ref": "#/definitions/Element" - }, - "clinicalRecommendationStatement": { - "description": "Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.", - "$ref": "#/definitions/markdown" - }, - "_clinicalRecommendationStatement": { - "description": "Extensions for clinicalRecommendationStatement", - "$ref": "#/definitions/Element" - }, - "improvementNotation": { - "description": "Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).", - "$ref": "#/definitions/CodeableConcept" - }, - "definition": { - "description": "Provides a description of an individual term used within the measure.", - "items": { - "$ref": "#/definitions/markdown" - }, - "type": "array" - }, - "_definition": { - "description": "Extensions for definition", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "guidance": { - "description": "Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.", - "$ref": "#/definitions/markdown" - }, - "_guidance": { - "description": "Extensions for guidance", - "$ref": "#/definitions/Element" - }, - "group": { - "description": "A group of population criteria for the measure.", - "items": { - "$ref": "#/definitions/Measure_Group" - }, - "type": "array" - }, - "supplementalData": { - "description": "The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.", - "items": { - "$ref": "#/definitions/Measure_SupplementalData" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Measure_Group": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "The human readable description of this population group.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "population": { - "description": "A population criteria for the measure.", - "items": { - "$ref": "#/definitions/Measure_Population" - }, - "type": "array" - }, - "stratifier": { - "description": "The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.", - "items": { - "$ref": "#/definitions/Measure_Stratifier" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Measure_Population": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The type of population criteria.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "The human readable description of this population criteria.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "criteria": { - "description": "An expression that specifies the criteria for the population, typically the name of an expression in a library.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false, - "required": [ - "criteria" - ] - }, - "Measure_Stratifier": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Indicates a meaning for the stratifier. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "The human readable description of this stratifier criteria.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "criteria": { - "description": "An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.", - "$ref": "#/definitions/Expression" - }, - "component": { - "description": "A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.", - "items": { - "$ref": "#/definitions/Measure_Component" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Measure_Component": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Indicates a meaning for the stratifier component. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing stratifiers to be correlated across measures.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "The human readable description of this stratifier criteria component.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "criteria": { - "description": "An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false, - "required": [ - "criteria" - ] - }, - "Measure_SupplementalData": { - "description": "The Measure resource provides the definition of a quality measure.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures.", - "$ref": "#/definitions/CodeableConcept" - }, - "usage": { - "description": "An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "The human readable description of this supplemental data.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "criteria": { - "description": "The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false, - "required": [ - "criteria" - ] - }, - "MeasureReport": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "resourceType": { - "description": "This is a MeasureReport resource", - "const": "MeasureReport" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The MeasureReport status. No data will be available until the MeasureReport status is complete.", - "enum": [ - "complete", - "pending", - "error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.", - "enum": [ - "individual", - "subject-list", - "summary", - "data-collection" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "measure": { - "description": "A reference to the Measure that was calculated to produce this report.", - "$ref": "#/definitions/canonical" - }, - "subject": { - "description": "Optional subject identifying the individual or individuals the report is for.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date this measure report was generated.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "reporter": { - "description": "The individual, location, or organization that is reporting the data.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "The reporting period for which the report was calculated.", - "$ref": "#/definitions/Period" - }, - "improvementNotation": { - "description": "Whether improvement in the measure is noted by an increase or decrease in the measure score.", - "$ref": "#/definitions/CodeableConcept" - }, - "group": { - "description": "The results of the calculation, one for each population group in the measure.", - "items": { - "$ref": "#/definitions/MeasureReport_Group" - }, - "type": "array" - }, - "evaluatedResource": { - "description": "A reference to a Bundle containing the Resources that were used in the calculation of this measure.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "period", - "measure", - "resourceType" - ] - }, - "MeasureReport_Group": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The meaning of the population group as defined in the measure definition.", - "$ref": "#/definitions/CodeableConcept" - }, - "population": { - "description": "The populations that make up the population group, one for each type of population appropriate for the measure.", - "items": { - "$ref": "#/definitions/MeasureReport_Population" - }, - "type": "array" - }, - "measureScore": { - "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", - "$ref": "#/definitions/Quantity" - }, - "stratifier": { - "description": "When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.", - "items": { - "$ref": "#/definitions/MeasureReport_Stratifier" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MeasureReport_Population": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The type of the population.", - "$ref": "#/definitions/CodeableConcept" - }, - "count": { - "description": "The number of members of the population.", - "$ref": "#/definitions/integer" - }, - "_count": { - "description": "Extensions for count", - "$ref": "#/definitions/Element" - }, - "subjectResults": { - "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MeasureReport_Stratifier": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The meaning of this stratifier, as defined in the measure definition.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "stratum": { - "description": "This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.", - "items": { - "$ref": "#/definitions/MeasureReport_Stratum" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MeasureReport_Stratum": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "value": { - "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", - "$ref": "#/definitions/CodeableConcept" - }, - "component": { - "description": "A stratifier component value.", - "items": { - "$ref": "#/definitions/MeasureReport_Component" - }, - "type": "array" - }, - "population": { - "description": "The populations that make up the stratum, one for each type of population appropriate to the measure.", - "items": { - "$ref": "#/definitions/MeasureReport_Population1" - }, - "type": "array" - }, - "measureScore": { - "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "MeasureReport_Component": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The code for the stratum component value.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "The stratum component value.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "code", - "value" - ] - }, - "MeasureReport_Population1": { - "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The type of the population.", - "$ref": "#/definitions/CodeableConcept" - }, - "count": { - "description": "The number of members of the population in this stratum.", - "$ref": "#/definitions/integer" - }, - "_count": { - "description": "Extensions for count", - "$ref": "#/definitions/Element" - }, - "subjectResults": { - "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Media": { - "description": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.", - "properties": { - "resourceType": { - "description": "This is a Media resource", - "const": "Media" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A procedure that is fulfilled in whole or in part by the creation of this media.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular event is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The current state of the {{title}}.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "A code that classifies whether the media is an image, video or audio recording or some other media category.", - "$ref": "#/definitions/CodeableConcept" - }, - "modality": { - "description": "Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.", - "$ref": "#/definitions/CodeableConcept" - }, - "view": { - "description": "The name of the imaging view e.g. Lateral or Antero-posterior (AP).", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Who/What this Media is a record of.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The encounter that establishes the context for this media.", - "$ref": "#/definitions/Reference" - }, - "createdDateTime": { - "description": "The date and time(s) at which the media was collected.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_createdDateTime": { - "description": "Extensions for createdDateTime", - "$ref": "#/definitions/Element" - }, - "createdPeriod": { - "description": "The date and time(s) at which the media was collected.", - "$ref": "#/definitions/Period" - }, - "issued": { - "description": "The date and time this version of the media was made available to providers, typically after having been reviewed.", - "$ref": "#/definitions/instant" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "operator": { - "description": "The person who administered the collection of the image.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Describes why the event occurred in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "bodySite": { - "description": "Indicates the site on the subject\u0027s body where the observation was made (i.e. the target site).", - "$ref": "#/definitions/CodeableConcept" - }, - "deviceName": { - "description": "The name of the device / manufacturer of the device that was used to make the recording.", - "$ref": "#/definitions/string" - }, - "_deviceName": { - "description": "Extensions for deviceName", - "$ref": "#/definitions/Element" - }, - "device": { - "description": "The device used to collect the media.", - "$ref": "#/definitions/Reference" - }, - "height": { - "description": "Height of the image in pixels (photo/video).", - "$ref": "#/definitions/positiveInt" - }, - "_height": { - "description": "Extensions for height", - "$ref": "#/definitions/Element" - }, - "width": { - "description": "Width of the image in pixels (photo/video).", - "$ref": "#/definitions/positiveInt" - }, - "_width": { - "description": "Extensions for width", - "$ref": "#/definitions/Element" - }, - "frames": { - "description": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.", - "$ref": "#/definitions/positiveInt" - }, - "_frames": { - "description": "Extensions for frames", - "$ref": "#/definitions/Element" - }, - "duration": { - "description": "The duration of the recording in seconds - for audio and video.", - "$ref": "#/definitions/decimal" - }, - "_duration": { - "description": "Extensions for duration", - "$ref": "#/definitions/Element" - }, - "content": { - "description": "The actual content of the media - inline or by direct reference to the media source file.", - "$ref": "#/definitions/Attachment" - }, - "note": { - "description": "Comments made about the media by the performer, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "content", - "resourceType" - ] - }, - "Medication": { - "description": "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.", - "properties": { - "resourceType": { - "description": "This is a Medication resource", - "const": "Medication" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifier for this medication.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "code": { - "description": "A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "A code to indicate if the medication is in active use.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "manufacturer": { - "description": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.", - "$ref": "#/definitions/Reference" - }, - "form": { - "description": "Describes the form of the item. Powder; tablets; capsule.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).", - "$ref": "#/definitions/Ratio" - }, - "ingredient": { - "description": "Identifies a particular constituent of interest in the product.", - "items": { - "$ref": "#/definitions/Medication_Ingredient" - }, - "type": "array" - }, - "batch": { - "description": "Information that only applies to packages (not products).", - "$ref": "#/definitions/Medication_Batch" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Medication_Ingredient": { - "description": "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemCodeableConcept": { - "description": "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.", - "$ref": "#/definitions/CodeableConcept" - }, - "itemReference": { - "description": "The actual ingredient - either a substance (simple ingredient) or another medication of a medication.", - "$ref": "#/definitions/Reference" - }, - "isActive": { - "description": "Indication of whether this ingredient affects the therapeutic action of the drug.", - "$ref": "#/definitions/boolean" - }, - "_isActive": { - "description": "Extensions for isActive", - "$ref": "#/definitions/Element" - }, - "strength": { - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.", - "$ref": "#/definitions/Ratio" - } - }, - "additionalProperties": false - }, - "Medication_Batch": { - "description": "This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "lotNumber": { - "description": "The assigned lot number of a batch of the specified product.", - "$ref": "#/definitions/string" - }, - "_lotNumber": { - "description": "Extensions for lotNumber", - "$ref": "#/definitions/Element" - }, - "expirationDate": { - "description": "When this specific batch of product will expire.", - "$ref": "#/definitions/dateTime" - }, - "_expirationDate": { - "description": "Extensions for expirationDate", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MedicationAdministration": { - "description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.", - "properties": { - "resourceType": { - "description": "This is a MedicationAdministration resource", - "const": "MedicationAdministration" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiates": { - "description": "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiates": { - "description": "Extensions for instantiates", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular event is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "A code indicating why the administration was not performed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "category": { - "description": "Indicates where the medication is expected to be consumed or administered.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationCodeableConcept": { - "description": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/Reference" - }, - "subject": { - "description": "The person or animal or group receiving the medication.", - "$ref": "#/definitions/Reference" - }, - "context": { - "description": "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.", - "$ref": "#/definitions/Reference" - }, - "supportingInformation": { - "description": "Additional information (for example, patient height and weight) that supports the administration of the medication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "effectiveDateTime": { - "description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the \u0027notGiven\u0027 attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_effectiveDateTime": { - "description": "Extensions for effectiveDateTime", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the \u0027notGiven\u0027 attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", - "$ref": "#/definitions/Period" - }, - "performer": { - "description": "Indicates who or what performed the medication administration and how they were involved.", - "items": { - "$ref": "#/definitions/MedicationAdministration_Performer" - }, - "type": "array" - }, - "reasonCode": { - "description": "A code indicating why the medication was given.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Condition or observation that supports why the medication was administered.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "request": { - "description": "The original request, instruction or authority to perform the administration.", - "$ref": "#/definitions/Reference" - }, - "device": { - "description": "The device used in administering the medication to the patient. For example, a particular infusion pump.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Extra information about the medication administration that is not conveyed by the other attributes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "dosage": { - "description": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.", - "$ref": "#/definitions/MedicationAdministration_Dosage" - }, - "eventHistory": { - "description": "A summary of the events of interest that have occurred, such as when the administration was verified.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "MedicationAdministration_Performer": { - "description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Distinguishes the type of involvement of the performer in the medication administration.", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "Indicates who or what performed the medication administration.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "MedicationAdministration_Dosage": { - "description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "text": { - "description": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "site": { - "description": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".", - "$ref": "#/definitions/CodeableConcept" - }, - "route": { - "description": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "method": { - "description": "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.", - "$ref": "#/definitions/CodeableConcept" - }, - "dose": { - "description": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.", - "$ref": "#/definitions/Quantity" - }, - "rateRatio": { - "description": "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.", - "$ref": "#/definitions/Ratio" - }, - "rateQuantity": { - "description": "Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "MedicationDispense": { - "description": "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.", - "properties": { - "resourceType": { - "description": "This is a MedicationDispense resource", - "const": "MedicationDispense" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "partOf": { - "description": "The procedure that trigger the dispense.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "A code specifying the state of the set of dispense events.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReasonCodeableConcept": { - "description": "Indicates the reason why a dispense was not performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "statusReasonReference": { - "description": "Indicates the reason why a dispense was not performed.", - "$ref": "#/definitions/Reference" - }, - "category": { - "description": "Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationCodeableConcept": { - "description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/Reference" - }, - "subject": { - "description": "A link to a resource representing the person or the group to whom the medication will be given.", - "$ref": "#/definitions/Reference" - }, - "context": { - "description": "The encounter or episode of care that establishes the context for this event.", - "$ref": "#/definitions/Reference" - }, - "supportingInformation": { - "description": "Additional information that supports the medication being dispensed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "performer": { - "description": "Indicates who or what performed the event.", - "items": { - "$ref": "#/definitions/MedicationDispense_Performer" - }, - "type": "array" - }, - "location": { - "description": "The principal physical location where the dispense was performed.", - "$ref": "#/definitions/Reference" - }, - "authorizingPrescription": { - "description": "Indicates the medication order that is being dispensed against.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "type": { - "description": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "quantity": { - "description": "The amount of medication that has been dispensed. Includes unit of measure.", - "$ref": "#/definitions/Quantity" - }, - "daysSupply": { - "description": "The amount of medication expressed as a timing amount.", - "$ref": "#/definitions/Quantity" - }, - "whenPrepared": { - "description": "The time when the dispensed product was packaged and reviewed.", - "$ref": "#/definitions/dateTime" - }, - "_whenPrepared": { - "description": "Extensions for whenPrepared", - "$ref": "#/definitions/Element" - }, - "whenHandedOver": { - "description": "The time the dispensed product was provided to the patient or their representative.", - "$ref": "#/definitions/dateTime" - }, - "_whenHandedOver": { - "description": "Extensions for whenHandedOver", - "$ref": "#/definitions/Element" - }, - "destination": { - "description": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.", - "$ref": "#/definitions/Reference" - }, - "receiver": { - "description": "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Extra information about the dispense that could not be conveyed in the other attributes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "dosageInstruction": { - "description": "Indicates how the medication is to be used by the patient.", - "items": { - "$ref": "#/definitions/Dosage" - }, - "type": "array" - }, - "substitution": { - "description": "Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.", - "$ref": "#/definitions/MedicationDispense_Substitution" - }, - "detectedIssue": { - "description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "eventHistory": { - "description": "A summary of the events of interest that have occurred, such as when the dispense was verified.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicationDispense_Performer": { - "description": "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "MedicationDispense_Substitution": { - "description": "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "wasSubstituted": { - "description": "True if the dispenser dispensed a different drug or product from what was prescribed.", - "$ref": "#/definitions/boolean" - }, - "_wasSubstituted": { - "description": "Extensions for wasSubstituted", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "A code signifying whether a different drug was dispensed from what was prescribed.", - "$ref": "#/definitions/CodeableConcept" - }, - "reason": { - "description": "Indicates the reason for the substitution (or lack of substitution) from what was prescribed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "responsibleParty": { - "description": "The person or organization that has primary responsibility for the substitution.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "resourceType": { - "description": "This is a MedicationKnowledge resource", - "const": "MedicationKnowledge" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "manufacturer": { - "description": "Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.", - "$ref": "#/definitions/Reference" - }, - "doseForm": { - "description": "Describes the form of the item. Powder; tablets; capsule.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).", - "$ref": "#/definitions/Quantity" - }, - "synonym": { - "description": "Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_synonym": { - "description": "Extensions for synonym", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "relatedMedicationKnowledge": { - "description": "Associated or related knowledge about a medication.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_RelatedMedicationKnowledge" - }, - "type": "array" - }, - "associatedMedication": { - "description": "Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "productType": { - "description": "Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "monograph": { - "description": "Associated documentation about the medication.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Monograph" - }, - "type": "array" - }, - "ingredient": { - "description": "Identifies a particular constituent of interest in the product.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Ingredient" - }, - "type": "array" - }, - "preparationInstruction": { - "description": "The instructions for preparing the medication.", - "$ref": "#/definitions/markdown" - }, - "_preparationInstruction": { - "description": "Extensions for preparationInstruction", - "$ref": "#/definitions/Element" - }, - "intendedRoute": { - "description": "The intended or approved route of administration.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "cost": { - "description": "The price of the medication.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Cost" - }, - "type": "array" - }, - "monitoringProgram": { - "description": "The program under which the medication is reviewed.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_MonitoringProgram" - }, - "type": "array" - }, - "administrationGuidelines": { - "description": "Guidelines for the administration of the medication.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_AdministrationGuidelines" - }, - "type": "array" - }, - "medicineClassification": { - "description": "Categorization of the medication within a formulary or classification system.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_MedicineClassification" - }, - "type": "array" - }, - "packaging": { - "description": "Information that only applies to packages (not products).", - "$ref": "#/definitions/MedicationKnowledge_Packaging" - }, - "drugCharacteristic": { - "description": "Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_DrugCharacteristic" - }, - "type": "array" - }, - "contraindication": { - "description": "Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "regulatory": { - "description": "Regulatory information about a medication.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Regulatory" - }, - "type": "array" - }, - "kinetics": { - "description": "The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Kinetics" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicationKnowledge_RelatedMedicationKnowledge": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The category of the associated medication knowledge reference.", - "$ref": "#/definitions/CodeableConcept" - }, - "reference": { - "description": "Associated documentation about the associated medication knowledge.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "reference", - "type" - ] - }, - "MedicationKnowledge_Monograph": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The category of documentation about the medication. (e.g. professional monograph, patient education monograph).", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "Associated documentation about the medication.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_Ingredient": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemCodeableConcept": { - "description": "The actual ingredient - either a substance (simple ingredient) or another medication.", - "$ref": "#/definitions/CodeableConcept" - }, - "itemReference": { - "description": "The actual ingredient - either a substance (simple ingredient) or another medication.", - "$ref": "#/definitions/Reference" - }, - "isActive": { - "description": "Indication of whether this ingredient affects the therapeutic action of the drug.", - "$ref": "#/definitions/boolean" - }, - "_isActive": { - "description": "Extensions for isActive", - "$ref": "#/definitions/Element" - }, - "strength": { - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.", - "$ref": "#/definitions/Ratio" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_Cost": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The category of the cost information. For example, manufacturers\u0027 cost, patient cost, claim reimbursement cost, actual acquisition cost.", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "The source or owner that assigns the price to the medication.", - "$ref": "#/definitions/string" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "cost": { - "description": "The price of the medication.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "cost", - "type" - ] - }, - "MedicationKnowledge_MonitoringProgram": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of program under which the medication is monitored.", - "$ref": "#/definitions/CodeableConcept" - }, - "name": { - "description": "Name of the reviewing program.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_AdministrationGuidelines": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "dosage": { - "description": "Dosage for the medication for the specific guidelines.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Dosage" - }, - "type": "array" - }, - "indicationCodeableConcept": { - "description": "Indication for use that apply to the specific administration guidelines.", - "$ref": "#/definitions/CodeableConcept" - }, - "indicationReference": { - "description": "Indication for use that apply to the specific administration guidelines.", - "$ref": "#/definitions/Reference" - }, - "patientCharacteristics": { - "description": "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).", - "items": { - "$ref": "#/definitions/MedicationKnowledge_PatientCharacteristics" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_Dosage": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "dosage": { - "description": "Dosage for the medication for the specific guidelines.", - "items": { - "$ref": "#/definitions/Dosage" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "dosage", - "type" - ] - }, - "MedicationKnowledge_PatientCharacteristics": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "characteristicCodeableConcept": { - "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).", - "$ref": "#/definitions/CodeableConcept" - }, - "characteristicQuantity": { - "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).", - "$ref": "#/definitions/Quantity" - }, - "value": { - "description": "The specific characteristic (e.g. height, weight, gender, etc.).", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_value": { - "description": "Extensions for value", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_MedicineClassification": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification).", - "$ref": "#/definitions/CodeableConcept" - }, - "classification": { - "description": "Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "MedicationKnowledge_Packaging": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle).", - "$ref": "#/definitions/CodeableConcept" - }, - "quantity": { - "description": "The number of product units the package would contain if fully loaded.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_DrugCharacteristic": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "A code specifying which characteristic of the medicine is being described (for example, colour, shape, imprint).", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCodeableConcept": { - "description": "Description of the characteristic.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueString": { - "description": "Description of the characteristic.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueQuantity": { - "description": "Description of the characteristic.", - "$ref": "#/definitions/Quantity" - }, - "valueBase64Binary": { - "description": "Description of the characteristic.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MedicationKnowledge_Regulatory": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "regulatoryAuthority": { - "description": "The authority that is specifying the regulations.", - "$ref": "#/definitions/Reference" - }, - "substitution": { - "description": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Substitution" - }, - "type": "array" - }, - "schedule": { - "description": "Specifies the schedule of a medication in jurisdiction.", - "items": { - "$ref": "#/definitions/MedicationKnowledge_Schedule" - }, - "type": "array" - }, - "maxDispense": { - "description": "The maximum number of units of the medication that can be dispensed in a period.", - "$ref": "#/definitions/MedicationKnowledge_MaxDispense" - } - }, - "additionalProperties": false, - "required": [ - "regulatoryAuthority" - ] - }, - "MedicationKnowledge_Substitution": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Specifies the type of substitution allowed.", - "$ref": "#/definitions/CodeableConcept" - }, - "allowed": { - "description": "Specifies if regulation allows for changes in the medication when dispensing.", - "$ref": "#/definitions/boolean" - }, - "_allowed": { - "description": "Extensions for allowed", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "MedicationKnowledge_Schedule": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "schedule": { - "description": "Specifies the specific drug schedule.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "schedule" - ] - }, - "MedicationKnowledge_MaxDispense": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "quantity": { - "description": "The maximum number of units of the medication that can be dispensed.", - "$ref": "#/definitions/Quantity" - }, - "period": { - "description": "The period that applies to the maximum number of units.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false, - "required": [ - "quantity" - ] - }, - "MedicationKnowledge_Kinetics": { - "description": "Information about a medication that is used to support knowledge.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "areaUnderCurve": { - "description": "The drug concentration measured at certain discrete points in time.", - "items": { - "$ref": "#/definitions/Quantity" - }, - "type": "array" - }, - "lethalDose50": { - "description": "The median lethal dose of a drug.", - "items": { - "$ref": "#/definitions/Quantity" - }, - "type": "array" - }, - "halfLifePeriod": { - "description": "The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "MedicationRequest": { - "description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "properties": { - "resourceType": { - "description": "This is a MedicationRequest resource", - "const": "MedicationRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "A code specifying the current state of the order. Generally, this will be active or completed state.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the MedicationRequest.", - "$ref": "#/definitions/CodeableConcept" - }, - "intent": { - "description": "Whether the request is a proposal, plan, or an original order.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "priority": { - "description": "Indicates how quickly the Medication Request should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "doNotPerform": { - "description": "If true indicates that the provider is asking for the medication request not to occur.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "reportedBoolean": { - "description": "Indicates if this record was captured as a secondary \u0027reported\u0027 record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_reportedBoolean": { - "description": "Extensions for reportedBoolean", - "$ref": "#/definitions/Element" - }, - "reportedReference": { - "description": "Indicates if this record was captured as a secondary \u0027reported\u0027 record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", - "$ref": "#/definitions/Reference" - }, - "medicationCodeableConcept": { - "description": "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/Reference" - }, - "subject": { - "description": "A link to a resource representing the person or set of individuals to whom the medication will be given.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "supportingInformation": { - "description": "Include additional information (for example, patient height and weight) that supports the ordering of the medication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "authoredOn": { - "description": "The date (and perhaps time) when the prescription was initially written or authored on.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The individual, organization, or device that initiated the request and has responsibility for its activation.", - "$ref": "#/definitions/Reference" - }, - "performer": { - "description": "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).", - "$ref": "#/definitions/Reference" - }, - "performerType": { - "description": "Indicates the type of performer of the administration of the medication.", - "$ref": "#/definitions/CodeableConcept" - }, - "recorder": { - "description": "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "The reason or the indication for ordering or not ordering the medication.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Condition or observation that supports why the medication was ordered.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "_instantiatesCanonical": { - "description": "Extensions for instantiatesCanonical", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan or request that is fulfilled in whole or in part by this medication request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "groupIdentifier": { - "description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.", - "$ref": "#/definitions/Identifier" - }, - "courseOfTherapyType": { - "description": "The description of the overall patte3rn of the administration of the medication to the patient.", - "$ref": "#/definitions/CodeableConcept" - }, - "insurance": { - "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Extra information about the prescription that could not be conveyed by the other attributes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "dosageInstruction": { - "description": "Indicates how the medication is to be used by the patient.", - "items": { - "$ref": "#/definitions/Dosage" - }, - "type": "array" - }, - "dispenseRequest": { - "description": "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.", - "$ref": "#/definitions/MedicationRequest_DispenseRequest" - }, - "substitution": { - "description": "Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber\u0027s intent. If nothing is specified substitution may be done.", - "$ref": "#/definitions/MedicationRequest_Substitution" - }, - "priorPrescription": { - "description": "A link to a resource representing an earlier order related order or prescription.", - "$ref": "#/definitions/Reference" - }, - "detectedIssue": { - "description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "eventHistory": { - "description": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "MedicationRequest_DispenseRequest": { - "description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "initialFill": { - "description": "Indicates the quantity or duration for the first dispense of the medication.", - "$ref": "#/definitions/MedicationRequest_InitialFill" - }, - "dispenseInterval": { - "description": "The minimum period of time that must occur between dispenses of the medication.", - "$ref": "#/definitions/Duration" - }, - "validityPeriod": { - "description": "This indicates the validity period of a prescription (stale dating the Prescription).", - "$ref": "#/definitions/Period" - }, - "numberOfRepeatsAllowed": { - "description": "An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.", - "$ref": "#/definitions/unsignedInt" - }, - "_numberOfRepeatsAllowed": { - "description": "Extensions for numberOfRepeatsAllowed", - "$ref": "#/definitions/Element" - }, - "quantity": { - "description": "The amount that is to be dispensed for one fill.", - "$ref": "#/definitions/Quantity" - }, - "expectedSupplyDuration": { - "description": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.", - "$ref": "#/definitions/Duration" - }, - "performer": { - "description": "Indicates the intended dispensing Organization specified by the prescriber.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MedicationRequest_InitialFill": { - "description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "quantity": { - "description": "The amount or quantity to provide as part of the first dispense.", - "$ref": "#/definitions/Quantity" - }, - "duration": { - "description": "The length of time that the first dispense is expected to last.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "MedicationRequest_Substitution": { - "description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "allowedBoolean": { - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_allowedBoolean": { - "description": "Extensions for allowedBoolean", - "$ref": "#/definitions/Element" - }, - "allowedCodeableConcept": { - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "$ref": "#/definitions/CodeableConcept" - }, - "reason": { - "description": "Indicates the reason for the substitution, or why substitution must or must not be performed.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "MedicationStatement": { - "description": "A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient\u0027s memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient\u0027s memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.", - "properties": { - "resourceType": { - "description": "This is a MedicationStatement resource", - "const": "MedicationStatement" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan, proposal or order that is fulfilled in whole or in part by this event.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular event is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "A code representing the patient or other source\u0027s judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the MedicationStatement.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "category": { - "description": "Indicates where the medication is expected to be consumed or administered.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationCodeableConcept": { - "description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", - "$ref": "#/definitions/Reference" - }, - "subject": { - "description": "The person, animal or group who is/was taking the medication.", - "$ref": "#/definitions/Reference" - }, - "context": { - "description": "The encounter or episode of care that establishes the context for this MedicationStatement.", - "$ref": "#/definitions/Reference" - }, - "effectiveDateTime": { - "description": "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_effectiveDateTime": { - "description": "Extensions for effectiveDateTime", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).", - "$ref": "#/definitions/Period" - }, - "dateAsserted": { - "description": "The date when the medication statement was asserted by the information source.", - "$ref": "#/definitions/dateTime" - }, - "_dateAsserted": { - "description": "Extensions for dateAsserted", - "$ref": "#/definitions/Element" - }, - "informationSource": { - "description": "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.", - "$ref": "#/definitions/Reference" - }, - "derivedFrom": { - "description": "Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "reasonCode": { - "description": "A reason for why the medication is being/was taken.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Condition or observation that supports why the medication is being/was taken.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Provides extra information about the medication statement that is not conveyed by the other attributes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "dosage": { - "description": "Indicates how the medication is/was or should be taken by the patient.", - "items": { - "$ref": "#/definitions/Dosage" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "MedicinalProduct": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "resourceType": { - "description": "This is a MedicinalProduct resource", - "const": "MedicinalProduct" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifier for this product. Could be an MPID.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "Regulatory type, e.g. Investigational or Authorized.", - "$ref": "#/definitions/CodeableConcept" - }, - "domain": { - "description": "If this medicine applies to human or veterinary uses.", - "$ref": "#/definitions/Coding" - }, - "combinedPharmaceuticalDoseForm": { - "description": "The dose form for a single part product, or combined form of a multiple part product.", - "$ref": "#/definitions/CodeableConcept" - }, - "legalStatusOfSupply": { - "description": "The legal status of supply of the medicinal product as classified by the regulator.", - "$ref": "#/definitions/CodeableConcept" - }, - "additionalMonitoringIndicator": { - "description": "Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.", - "$ref": "#/definitions/CodeableConcept" - }, - "specialMeasures": { - "description": "Whether the Medicinal Product is subject to special measures for regulatory reasons.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_specialMeasures": { - "description": "Extensions for specialMeasures", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "paediatricUseIndicator": { - "description": "If authorised for use in children.", - "$ref": "#/definitions/CodeableConcept" - }, - "productClassification": { - "description": "Allows the product to be classified by various systems.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "marketingStatus": { - "description": "Marketing status of the medicinal product, in contrast to marketing authorizaton.", - "items": { - "$ref": "#/definitions/MarketingStatus" - }, - "type": "array" - }, - "pharmaceuticalProduct": { - "description": "Pharmaceutical aspects of product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "packagedMedicinalProduct": { - "description": "Package representation for the product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "attachedDocument": { - "description": "Supporting documentation, typically for regulatory submission.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "masterFile": { - "description": "A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "contact": { - "description": "A product specific contact, person (in a role), or an organization.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "clinicalTrial": { - "description": "Clinical trials or studies that this product is involved in.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "name": { - "description": "The product\u0027s name, including full name and possibly coded parts.", - "items": { - "$ref": "#/definitions/MedicinalProduct_Name" - }, - "type": "array" - }, - "crossReference": { - "description": "Reference to another product, e.g. for linking authorised to investigational product.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "manufacturingBusinessOperation": { - "description": "An operation applied to the product, for manufacturing or adminsitrative purpose.", - "items": { - "$ref": "#/definitions/MedicinalProduct_ManufacturingBusinessOperation" - }, - "type": "array" - }, - "specialDesignation": { - "description": "Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.", - "items": { - "$ref": "#/definitions/MedicinalProduct_SpecialDesignation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "name", - "resourceType" - ] - }, - "MedicinalProduct_Name": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "productName": { - "description": "The full product name.", - "$ref": "#/definitions/string" - }, - "_productName": { - "description": "Extensions for productName", - "$ref": "#/definitions/Element" - }, - "namePart": { - "description": "Coding words or phrases of the name.", - "items": { - "$ref": "#/definitions/MedicinalProduct_NamePart" - }, - "type": "array" - }, - "countryLanguage": { - "description": "Country where the name applies.", - "items": { - "$ref": "#/definitions/MedicinalProduct_CountryLanguage" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MedicinalProduct_NamePart": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "part": { - "description": "A fragment of a product name.", - "$ref": "#/definitions/string" - }, - "_part": { - "description": "Extensions for part", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Idenifying type for this part of the name (e.g. strength part).", - "$ref": "#/definitions/Coding" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "MedicinalProduct_CountryLanguage": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "country": { - "description": "Country code for where this name applies.", - "$ref": "#/definitions/CodeableConcept" - }, - "jurisdiction": { - "description": "Jurisdiction code for where this name applies.", - "$ref": "#/definitions/CodeableConcept" - }, - "language": { - "description": "Language code for this name.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "country", - "language" - ] - }, - "MedicinalProduct_ManufacturingBusinessOperation": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operationType": { - "description": "The type of manufacturing operation.", - "$ref": "#/definitions/CodeableConcept" - }, - "authorisationReferenceNumber": { - "description": "Regulatory authorization reference number.", - "$ref": "#/definitions/Identifier" - }, - "effectiveDate": { - "description": "Regulatory authorization date.", - "$ref": "#/definitions/dateTime" - }, - "_effectiveDate": { - "description": "Extensions for effectiveDate", - "$ref": "#/definitions/Element" - }, - "confidentialityIndicator": { - "description": "To indicate if this proces is commercially confidential.", - "$ref": "#/definitions/CodeableConcept" - }, - "manufacturer": { - "description": "The manufacturer or establishment associated with the process.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "regulator": { - "description": "A regulator which oversees the operation.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MedicinalProduct_SpecialDesignation": { - "description": "Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the designation, or procedure number.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "The type of special designation, e.g. orphan drug, minor use.", - "$ref": "#/definitions/CodeableConcept" - }, - "intendedUse": { - "description": "The intended use of the product, e.g. prevention, treatment.", - "$ref": "#/definitions/CodeableConcept" - }, - "indicationCodeableConcept": { - "description": "Condition for which the medicinal use applies.", - "$ref": "#/definitions/CodeableConcept" - }, - "indicationReference": { - "description": "Condition for which the medicinal use applies.", - "$ref": "#/definitions/Reference" - }, - "status": { - "description": "For example granted, pending, expired or withdrawn.", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "Date when the designation was granted.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "species": { - "description": "Animal species for which this applies.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "MedicinalProductAuthorization": { - "description": "The regulatory authorization of a medicinal product.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductAuthorization resource", - "const": "MedicinalProductAuthorization" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifier for the marketing authorization, as assigned by a regulator.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "subject": { - "description": "The medicinal product that is being authorized.", - "$ref": "#/definitions/Reference" - }, - "country": { - "description": "The country in which the marketing authorization has been granted.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "jurisdiction": { - "description": "Jurisdiction within a country.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "status": { - "description": "The status of the marketing authorization.", - "$ref": "#/definitions/CodeableConcept" - }, - "statusDate": { - "description": "The date at which the given status has become applicable.", - "$ref": "#/definitions/dateTime" - }, - "_statusDate": { - "description": "Extensions for statusDate", - "$ref": "#/definitions/Element" - }, - "restoreDate": { - "description": "The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.", - "$ref": "#/definitions/dateTime" - }, - "_restoreDate": { - "description": "Extensions for restoreDate", - "$ref": "#/definitions/Element" - }, - "validityPeriod": { - "description": "The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.", - "$ref": "#/definitions/Period" - }, - "dataExclusivityPeriod": { - "description": "A period of time after authorization before generic product applicatiosn can be submitted.", - "$ref": "#/definitions/Period" - }, - "dateOfFirstAuthorization": { - "description": "The date when the first authorization was granted by a Medicines Regulatory Agency.", - "$ref": "#/definitions/dateTime" - }, - "_dateOfFirstAuthorization": { - "description": "Extensions for dateOfFirstAuthorization", - "$ref": "#/definitions/Element" - }, - "internationalBirthDate": { - "description": "Date of first marketing authorization for a company\u0027s new medicinal product in any country in the World.", - "$ref": "#/definitions/dateTime" - }, - "_internationalBirthDate": { - "description": "Extensions for internationalBirthDate", - "$ref": "#/definitions/Element" - }, - "legalBasis": { - "description": "The legal framework against which this authorization is granted.", - "$ref": "#/definitions/CodeableConcept" - }, - "jurisdictionalAuthorization": { - "description": "Authorization in areas within a country.", - "items": { - "$ref": "#/definitions/MedicinalProductAuthorization_JurisdictionalAuthorization" - }, - "type": "array" - }, - "holder": { - "description": "Marketing Authorization Holder.", - "$ref": "#/definitions/Reference" - }, - "regulator": { - "description": "Medicines Regulatory Agency.", - "$ref": "#/definitions/Reference" - }, - "procedure": { - "description": "The regulatory procedure for granting or amending a marketing authorization.", - "$ref": "#/definitions/MedicinalProductAuthorization_Procedure" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicinalProductAuthorization_JurisdictionalAuthorization": { - "description": "The regulatory authorization of a medicinal product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The assigned number for the marketing authorization.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "country": { - "description": "Country of authorization.", - "$ref": "#/definitions/CodeableConcept" - }, - "jurisdiction": { - "description": "Jurisdiction within a country.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "legalStatusOfSupply": { - "description": "The legal status of supply in a jurisdiction or region.", - "$ref": "#/definitions/CodeableConcept" - }, - "validityPeriod": { - "description": "The start and expected end date of the authorization.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "MedicinalProductAuthorization_Procedure": { - "description": "The regulatory authorization of a medicinal product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for this procedure.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "Type of procedure.", - "$ref": "#/definitions/CodeableConcept" - }, - "datePeriod": { - "description": "Date of procedure.", - "$ref": "#/definitions/Period" - }, - "dateDateTime": { - "description": "Date of procedure.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_dateDateTime": { - "description": "Extensions for dateDateTime", - "$ref": "#/definitions/Element" - }, - "application": { - "description": "Applcations submitted to obtain a marketing authorization.", - "items": { - "$ref": "#/definitions/MedicinalProductAuthorization_Procedure" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "MedicinalProductContraindication": { - "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductContraindication resource", - "const": "MedicinalProductContraindication" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subject": { - "description": "The medication for which this is an indication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "disease": { - "description": "The disease, symptom or procedure for the contraindication.", - "$ref": "#/definitions/CodeableConcept" - }, - "diseaseStatus": { - "description": "The status of the disease or symptom for the contraindication.", - "$ref": "#/definitions/CodeableConcept" - }, - "comorbidity": { - "description": "A comorbidity (concurrent condition) or coinfection.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "therapeuticIndication": { - "description": "Information about the use of the medicinal product in relation to other therapies as part of the indication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "otherTherapy": { - "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication.", - "items": { - "$ref": "#/definitions/MedicinalProductContraindication_OtherTherapy" - }, - "type": "array" - }, - "population": { - "description": "The population group to which this applies.", - "items": { - "$ref": "#/definitions/Population" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicinalProductContraindication_OtherTherapy": { - "description": "The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "therapyRelationshipType": { - "description": "The type of relationship between the medicinal product indication or contraindication and another therapy.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationCodeableConcept": { - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "therapyRelationshipType" - ] - }, - "MedicinalProductIndication": { - "description": "Indication for the Medicinal Product.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductIndication resource", - "const": "MedicinalProductIndication" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subject": { - "description": "The medication for which this is an indication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "diseaseSymptomProcedure": { - "description": "The disease, symptom or procedure that is the indication for treatment.", - "$ref": "#/definitions/CodeableConcept" - }, - "diseaseStatus": { - "description": "The status of the disease or symptom for which the indication applies.", - "$ref": "#/definitions/CodeableConcept" - }, - "comorbidity": { - "description": "Comorbidity (concurrent condition) or co-infection as part of the indication.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "intendedEffect": { - "description": "The intended effect, aim or strategy to be achieved by the indication.", - "$ref": "#/definitions/CodeableConcept" - }, - "duration": { - "description": "Timing or duration information as part of the indication.", - "$ref": "#/definitions/Quantity" - }, - "otherTherapy": { - "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication.", - "items": { - "$ref": "#/definitions/MedicinalProductIndication_OtherTherapy" - }, - "type": "array" - }, - "undesirableEffect": { - "description": "Describe the undesirable effects of the medicinal product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "population": { - "description": "The population group to which this applies.", - "items": { - "$ref": "#/definitions/Population" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicinalProductIndication_OtherTherapy": { - "description": "Indication for the Medicinal Product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "therapyRelationshipType": { - "description": "The type of relationship between the medicinal product indication or contraindication and another therapy.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationCodeableConcept": { - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.", - "$ref": "#/definitions/CodeableConcept" - }, - "medicationReference": { - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "therapyRelationshipType" - ] - }, - "MedicinalProductIngredient": { - "description": "An ingredient of a manufactured item or pharmaceutical product.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductIngredient resource", - "const": "MedicinalProductIngredient" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.", - "$ref": "#/definitions/Identifier" - }, - "role": { - "description": "Ingredient role e.g. Active ingredient, excipient.", - "$ref": "#/definitions/CodeableConcept" - }, - "allergenicIndicator": { - "description": "If the ingredient is a known or suspected allergen.", - "$ref": "#/definitions/boolean" - }, - "_allergenicIndicator": { - "description": "Extensions for allergenicIndicator", - "$ref": "#/definitions/Element" - }, - "manufacturer": { - "description": "Manufacturer of this Ingredient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "specifiedSubstance": { - "description": "A specified substance that comprises this ingredient.", - "items": { - "$ref": "#/definitions/MedicinalProductIngredient_SpecifiedSubstance" - }, - "type": "array" - }, - "substance": { - "description": "The ingredient substance.", - "$ref": "#/definitions/MedicinalProductIngredient_Substance" - } - }, - "additionalProperties": false, - "required": [ - "role", - "resourceType" - ] - }, - "MedicinalProductIngredient_SpecifiedSubstance": { - "description": "An ingredient of a manufactured item or pharmaceutical product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The specified substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "group": { - "description": "The group of specified substance, e.g. group 1 to 4.", - "$ref": "#/definitions/CodeableConcept" - }, - "confidentiality": { - "description": "Confidentiality level of the specified substance as the ingredient.", - "$ref": "#/definitions/CodeableConcept" - }, - "strength": { - "description": "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.", - "items": { - "$ref": "#/definitions/MedicinalProductIngredient_Strength" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code", - "group" - ] - }, - "MedicinalProductIngredient_Strength": { - "description": "An ingredient of a manufactured item or pharmaceutical product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "presentation": { - "description": "The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.", - "$ref": "#/definitions/Ratio" - }, - "presentationLowLimit": { - "description": "A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.", - "$ref": "#/definitions/Ratio" - }, - "concentration": { - "description": "The strength per unitary volume (or mass).", - "$ref": "#/definitions/Ratio" - }, - "concentrationLowLimit": { - "description": "A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.", - "$ref": "#/definitions/Ratio" - }, - "measurementPoint": { - "description": "For when strength is measured at a particular point or distance.", - "$ref": "#/definitions/string" - }, - "_measurementPoint": { - "description": "Extensions for measurementPoint", - "$ref": "#/definitions/Element" - }, - "country": { - "description": "The country or countries for which the strength range applies.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "referenceStrength": { - "description": "Strength expressed in terms of a reference substance.", - "items": { - "$ref": "#/definitions/MedicinalProductIngredient_ReferenceStrength" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "presentation" - ] - }, - "MedicinalProductIngredient_ReferenceStrength": { - "description": "An ingredient of a manufactured item or pharmaceutical product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "substance": { - "description": "Relevant reference substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "strength": { - "description": "Strength expressed in terms of a reference substance.", - "$ref": "#/definitions/Ratio" - }, - "strengthLowLimit": { - "description": "Strength expressed in terms of a reference substance.", - "$ref": "#/definitions/Ratio" - }, - "measurementPoint": { - "description": "For when strength is measured at a particular point or distance.", - "$ref": "#/definitions/string" - }, - "_measurementPoint": { - "description": "Extensions for measurementPoint", - "$ref": "#/definitions/Element" - }, - "country": { - "description": "The country or countries for which the strength range applies.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "strength" - ] - }, - "MedicinalProductIngredient_Substance": { - "description": "An ingredient of a manufactured item or pharmaceutical product.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The ingredient substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "strength": { - "description": "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.", - "items": { - "$ref": "#/definitions/MedicinalProductIngredient_Strength" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "MedicinalProductInteraction": { - "description": "The interactions of the medicinal product with other medicinal products, or other forms of interactions.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductInteraction resource", - "const": "MedicinalProductInteraction" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subject": { - "description": "The medication for which this is a described interaction.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "description": { - "description": "The interaction described.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "interactant": { - "description": "The specific medication, food or laboratory test that interacts.", - "items": { - "$ref": "#/definitions/MedicinalProductInteraction_Interactant" - }, - "type": "array" - }, - "type": { - "description": "The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.", - "$ref": "#/definitions/CodeableConcept" - }, - "effect": { - "description": "The effect of the interaction, for example \"reduced gastric absorption of primary medication\".", - "$ref": "#/definitions/CodeableConcept" - }, - "incidence": { - "description": "The incidence of the interaction, e.g. theoretical, observed.", - "$ref": "#/definitions/CodeableConcept" - }, - "management": { - "description": "Actions for managing the interaction.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MedicinalProductInteraction_Interactant": { - "description": "The interactions of the medicinal product with other medicinal products, or other forms of interactions.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "itemReference": { - "description": "The specific medication, food or laboratory test that interacts.", - "$ref": "#/definitions/Reference" - }, - "itemCodeableConcept": { - "description": "The specific medication, food or laboratory test that interacts.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "MedicinalProductManufactured": { - "description": "The manufactured item as contained in the packaged medicinal product.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductManufactured resource", - "const": "MedicinalProductManufactured" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "manufacturedDoseForm": { - "description": "Dose form as manufactured and before any transformation into the pharmaceutical product.", - "$ref": "#/definitions/CodeableConcept" - }, - "unitOfPresentation": { - "description": "The “real world” units in which the quantity of the manufactured item is described.", - "$ref": "#/definitions/CodeableConcept" - }, - "quantity": { - "description": "The quantity or \"count number\" of the manufactured item.", - "$ref": "#/definitions/Quantity" - }, - "manufacturer": { - "description": "Manufacturer of the item (Note that this should be named \"manufacturer\" but it currently causes technical issues).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "ingredient": { - "description": "Ingredient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "physicalCharacteristics": { - "description": "Dimensions, color etc.", - "$ref": "#/definitions/ProdCharacteristic" - }, - "otherCharacteristics": { - "description": "Other codeable characteristics.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "quantity", - "manufacturedDoseForm", - "resourceType" - ] - }, - "MedicinalProductPackaged": { - "description": "A medicinal product in a container or package.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductPackaged resource", - "const": "MedicinalProductPackaged" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "subject": { - "description": "The product with this is a pack for.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "description": { - "description": "Textual description.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "legalStatusOfSupply": { - "description": "The legal status of supply of the medicinal product as classified by the regulator.", - "$ref": "#/definitions/CodeableConcept" - }, - "marketingStatus": { - "description": "Marketing information.", - "items": { - "$ref": "#/definitions/MarketingStatus" - }, - "type": "array" - }, - "marketingAuthorization": { - "description": "Manufacturer of this Package Item.", - "$ref": "#/definitions/Reference" - }, - "manufacturer": { - "description": "Manufacturer of this Package Item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "batchIdentifier": { - "description": "Batch numbering.", - "items": { - "$ref": "#/definitions/MedicinalProductPackaged_BatchIdentifier" - }, - "type": "array" - }, - "packageItem": { - "description": "A packaging item, as a contained for medicine, possibly with other packaging items within.", - "items": { - "$ref": "#/definitions/MedicinalProductPackaged_PackageItem" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "packageItem", - "resourceType" - ] - }, - "MedicinalProductPackaged_BatchIdentifier": { - "description": "A medicinal product in a container or package.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "outerPackaging": { - "description": "A number appearing on the outer packaging of a specific batch.", - "$ref": "#/definitions/Identifier" - }, - "immediatePackaging": { - "description": "A number appearing on the immediate packaging (and not the outer packaging).", - "$ref": "#/definitions/Identifier" - } - }, - "additionalProperties": false, - "required": [ - "outerPackaging" - ] - }, - "MedicinalProductPackaged_PackageItem": { - "description": "A medicinal product in a container or package.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Including possibly Data Carrier Identifier.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "The physical type of the container of the medicine.", - "$ref": "#/definitions/CodeableConcept" - }, - "quantity": { - "description": "The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1.", - "$ref": "#/definitions/Quantity" - }, - "material": { - "description": "Material type of the package item.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "alternateMaterial": { - "description": "A possible alternate material for the packaging.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "device": { - "description": "A device accompanying a medicinal product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "manufacturedItem": { - "description": "The manufactured item as contained in the packaged medicinal product.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "packageItem": { - "description": "Allows containers within containers.", - "items": { - "$ref": "#/definitions/MedicinalProductPackaged_PackageItem" - }, - "type": "array" - }, - "physicalCharacteristics": { - "description": "Dimensions, color etc.", - "$ref": "#/definitions/ProdCharacteristic" - }, - "otherCharacteristics": { - "description": "Other codeable characteristics.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "shelfLifeStorage": { - "description": "Shelf Life and storage information.", - "items": { - "$ref": "#/definitions/ProductShelfLife" - }, - "type": "array" - }, - "manufacturer": { - "description": "Manufacturer of this Package Item.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "quantity", - "type" - ] - }, - "MedicinalProductPharmaceutical": { - "description": "A pharmaceutical product described in terms of its composition and dose form.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductPharmaceutical resource", - "const": "MedicinalProductPharmaceutical" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An identifier for the pharmaceutical medicinal product.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "administrableDoseForm": { - "description": "The administrable dose form, after necessary reconstitution.", - "$ref": "#/definitions/CodeableConcept" - }, - "unitOfPresentation": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "ingredient": { - "description": "Ingredient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "device": { - "description": "Accompanying device.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "characteristics": { - "description": "Characteristics e.g. a products onset of action.", - "items": { - "$ref": "#/definitions/MedicinalProductPharmaceutical_Characteristics" - }, - "type": "array" - }, - "routeOfAdministration": { - "description": "The path by which the pharmaceutical product is taken into or makes contact with the body.", - "items": { - "$ref": "#/definitions/MedicinalProductPharmaceutical_RouteOfAdministration" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "administrableDoseForm", - "routeOfAdministration", - "resourceType" - ] - }, - "MedicinalProductPharmaceutical_Characteristics": { - "description": "A pharmaceutical product described in terms of its composition and dose form.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A coded characteristic.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The status of characteristic e.g. assigned or pending.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "MedicinalProductPharmaceutical_RouteOfAdministration": { - "description": "A pharmaceutical product described in terms of its composition and dose form.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Coded expression for the route.", - "$ref": "#/definitions/CodeableConcept" - }, - "firstDose": { - "description": "The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.", - "$ref": "#/definitions/Quantity" - }, - "maxSingleDose": { - "description": "The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.", - "$ref": "#/definitions/Quantity" - }, - "maxDosePerDay": { - "description": "The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.", - "$ref": "#/definitions/Quantity" - }, - "maxDosePerTreatmentPeriod": { - "description": "The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.", - "$ref": "#/definitions/Ratio" - }, - "maxTreatmentPeriod": { - "description": "The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.", - "$ref": "#/definitions/Duration" - }, - "targetSpecies": { - "description": "A species for which this route applies.", - "items": { - "$ref": "#/definitions/MedicinalProductPharmaceutical_TargetSpecies" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "MedicinalProductPharmaceutical_TargetSpecies": { - "description": "A pharmaceutical product described in terms of its composition and dose form.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Coded expression for the species.", - "$ref": "#/definitions/CodeableConcept" - }, - "withdrawalPeriod": { - "description": "A species specific time during which consumption of animal product is not appropriate.", - "items": { - "$ref": "#/definitions/MedicinalProductPharmaceutical_WithdrawalPeriod" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "MedicinalProductPharmaceutical_WithdrawalPeriod": { - "description": "A pharmaceutical product described in terms of its composition and dose form.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "tissue": { - "description": "Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "A value for the time.", - "$ref": "#/definitions/Quantity" - }, - "supportingInformation": { - "description": "Extra information about the withdrawal period.", - "$ref": "#/definitions/string" - }, - "_supportingInformation": { - "description": "Extensions for supportingInformation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "tissue", - "value" - ] - }, - "MedicinalProductUndesirableEffect": { - "description": "Describe the undesirable effects of the medicinal product.", - "properties": { - "resourceType": { - "description": "This is a MedicinalProductUndesirableEffect resource", - "const": "MedicinalProductUndesirableEffect" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subject": { - "description": "The medication for which this is an indication.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "symptomConditionEffect": { - "description": "The symptom, condition or undesirable effect.", - "$ref": "#/definitions/CodeableConcept" - }, - "classification": { - "description": "Classification of the effect.", - "$ref": "#/definitions/CodeableConcept" - }, - "frequencyOfOccurrence": { - "description": "The frequency of occurrence of the effect.", - "$ref": "#/definitions/CodeableConcept" - }, - "population": { - "description": "The population group to which this applies.", - "items": { - "$ref": "#/definitions/Population" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MessageDefinition": { - "description": "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.", - "properties": { - "resourceType": { - "description": "This is a MessageDefinition resource", - "const": "MessageDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the message definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "replaces": { - "description": "A MessageDefinition that is superseded by this definition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "status": { - "description": "The status of this message definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the message definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the message definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the message definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this message definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "base": { - "description": "The MessageDefinition that is the basis for the contents of this resource.", - "$ref": "#/definitions/canonical" - }, - "parent": { - "description": "Identifies a protocol or workflow that this MessageDefinition represents a step in.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "eventCoding": { - "description": "Event code or link to the EventDefinition.", - "$ref": "#/definitions/Coding" - }, - "eventUri": { - "description": "Event code or link to the EventDefinition.", - "pattern": "^\\S*$", - "type": "string" - }, - "_eventUri": { - "description": "Extensions for eventUri", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "The impact of the content of the message.", - "enum": [ - "consequence", - "currency", - "notification" - ] - }, - "_category": { - "description": "Extensions for category", - "$ref": "#/definitions/Element" - }, - "focus": { - "description": "Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.", - "items": { - "$ref": "#/definitions/MessageDefinition_Focus" - }, - "type": "array" - }, - "responseRequired": { - "description": "Declare at a message definition level whether a response is required or only upon error or success, or never.", - "enum": [ - "always", - "on-error", - "never", - "on-success" - ] - }, - "_responseRequired": { - "description": "Extensions for responseRequired", - "$ref": "#/definitions/Element" - }, - "allowedResponse": { - "description": "Indicates what types of messages may be sent as an application-level response to this message.", - "items": { - "$ref": "#/definitions/MessageDefinition_AllowedResponse" - }, - "type": "array" - }, - "graph": { - "description": "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MessageDefinition_Focus": { - "description": "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The kind of resource that must be the focus for this message.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "A profile that reflects constraints for the focal resource (and potentially for related resources).", - "$ref": "#/definitions/canonical" - }, - "min": { - "description": "Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.", - "$ref": "#/definitions/unsignedInt" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MessageDefinition_AllowedResponse": { - "description": "Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "message": { - "description": "A reference to the message definition that must be adhered to by this supported response.", - "$ref": "#/definitions/canonical" - }, - "situation": { - "description": "Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).", - "$ref": "#/definitions/markdown" - }, - "_situation": { - "description": "Extensions for situation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "message" - ] - }, - "MessageHeader": { - "description": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.", - "properties": { - "resourceType": { - "description": "This is a MessageHeader resource", - "const": "MessageHeader" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "eventCoding": { - "description": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.", - "$ref": "#/definitions/Coding" - }, - "eventUri": { - "description": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.", - "pattern": "^\\S*$", - "type": "string" - }, - "_eventUri": { - "description": "Extensions for eventUri", - "$ref": "#/definitions/Element" - }, - "destination": { - "description": "The destination application which the message is intended for.", - "items": { - "$ref": "#/definitions/MessageHeader_Destination" - }, - "type": "array" - }, - "sender": { - "description": "Identifies the sending system to allow the use of a trust relationship.", - "$ref": "#/definitions/Reference" - }, - "enterer": { - "description": "The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.", - "$ref": "#/definitions/Reference" - }, - "author": { - "description": "The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.", - "$ref": "#/definitions/Reference" - }, - "source": { - "description": "The source application from which this message originated.", - "$ref": "#/definitions/MessageHeader_Source" - }, - "responsible": { - "description": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.", - "$ref": "#/definitions/Reference" - }, - "reason": { - "description": "Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.", - "$ref": "#/definitions/CodeableConcept" - }, - "response": { - "description": "Information about the message that this message is a response to. Only present if this message is a response.", - "$ref": "#/definitions/MessageHeader_Response" - }, - "focus": { - "description": "The actual data of the message - a reference to the root/focus class of the event.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "definition": { - "description": "Permanent link to the MessageDefinition for this message.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "source", - "resourceType" - ] - }, - "MessageHeader_Destination": { - "description": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Human-readable name for the target system.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.", - "$ref": "#/definitions/Reference" - }, - "endpoint": { - "description": "Indicates where the message should be routed to.", - "$ref": "#/definitions/url" - }, - "_endpoint": { - "description": "Extensions for endpoint", - "$ref": "#/definitions/Element" - }, - "receiver": { - "description": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn\u0027t sufficient.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MessageHeader_Source": { - "description": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Human-readable name for the source system.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "software": { - "description": "May include configuration or other information useful in debugging.", - "$ref": "#/definitions/string" - }, - "_software": { - "description": "Extensions for software", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "Can convey versions of multiple systems in situations where a message passes through multiple hands.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.", - "$ref": "#/definitions/ContactPoint" - }, - "endpoint": { - "description": "Identifies the routing target to send acknowledgements to.", - "$ref": "#/definitions/url" - }, - "_endpoint": { - "description": "Extensions for endpoint", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MessageHeader_Response": { - "description": "The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The MessageHeader.id of the message to which this message is a response.", - "$ref": "#/definitions/id" - }, - "_identifier": { - "description": "Extensions for identifier", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.", - "enum": [ - "ok", - "transient-error", - "fatal-error" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "details": { - "description": "Full details of any issues found in the message.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MolecularSequence": { - "description": "Raw data describing a biological sequence.", - "properties": { - "resourceType": { - "description": "This is a MolecularSequence resource", - "const": "MolecularSequence" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier for this particular sequence instance. This is a FHIR-defined id.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "type": { - "description": "Amino Acid Sequence/ DNA Sequence / RNA Sequence.", - "enum": [ - "aa", - "dna", - "rna" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "coordinateSystem": { - "description": "Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).", - "$ref": "#/definitions/integer" - }, - "_coordinateSystem": { - "description": "Extensions for coordinateSystem", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The patient whose sequencing results are described by this resource.", - "$ref": "#/definitions/Reference" - }, - "specimen": { - "description": "Specimen used for sequencing.", - "$ref": "#/definitions/Reference" - }, - "device": { - "description": "The method for sequencing, for example, chip information.", - "$ref": "#/definitions/Reference" - }, - "performer": { - "description": "The organization or lab that should be responsible for this result.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The number of copies of the sequence of interest. (RNASeq).", - "$ref": "#/definitions/Quantity" - }, - "referenceSeq": { - "description": "A sequence that is used as a reference to describe variants that are present in a sequence analyzed.", - "$ref": "#/definitions/MolecularSequence_ReferenceSeq" - }, - "variant": { - "description": "The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.", - "items": { - "$ref": "#/definitions/MolecularSequence_Variant" - }, - "type": "array" - }, - "observedSeq": { - "description": "Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.", - "$ref": "#/definitions/string" - }, - "_observedSeq": { - "description": "Extensions for observedSeq", - "$ref": "#/definitions/Element" - }, - "quality": { - "description": "An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).", - "items": { - "$ref": "#/definitions/MolecularSequence_Quality" - }, - "type": "array" - }, - "readCoverage": { - "description": "Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.", - "$ref": "#/definitions/integer" - }, - "_readCoverage": { - "description": "Extensions for readCoverage", - "$ref": "#/definitions/Element" - }, - "repository": { - "description": "Configurations of the external repository. The repository shall store target\u0027s observedSeq or records related with target\u0027s observedSeq.", - "items": { - "$ref": "#/definitions/MolecularSequence_Repository" - }, - "type": "array" - }, - "pointer": { - "description": "Pointer to next atomic sequence which at most contains one variant.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "structureVariant": { - "description": "Information about chromosome structure variation.", - "items": { - "$ref": "#/definitions/MolecularSequence_StructureVariant" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "MolecularSequence_ReferenceSeq": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "chromosome": { - "description": "Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).", - "$ref": "#/definitions/CodeableConcept" - }, - "genomeBuild": { - "description": "The Genome Build used for reference, following GRCh build versions e.g. \u0027GRCh 37\u0027. Version number must be included if a versioned release of a primary build was used.", - "$ref": "#/definitions/string" - }, - "_genomeBuild": { - "description": "Extensions for genomeBuild", - "$ref": "#/definitions/Element" - }, - "orientation": { - "description": "A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the \"sense\" strand, and the opposite complementary strand is the \"antisense\" strand.", - "enum": [ - "sense", - "antisense" - ] - }, - "_orientation": { - "description": "Extensions for orientation", - "$ref": "#/definitions/Element" - }, - "referenceSeqId": { - "description": "Reference identifier of reference sequence submitted to NCBI. It must match the type in the MolecularSequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.", - "$ref": "#/definitions/CodeableConcept" - }, - "referenceSeqPointer": { - "description": "A pointer to another MolecularSequence entity as reference sequence.", - "$ref": "#/definitions/Reference" - }, - "referenceSeqString": { - "description": "A string like \"ACGT\".", - "$ref": "#/definitions/string" - }, - "_referenceSeqString": { - "description": "Extensions for referenceSeqString", - "$ref": "#/definitions/Element" - }, - "strand": { - "description": "An absolute reference to a strand. The Watson strand is the strand whose 5\u0027-end is on the short arm of the chromosome, and the Crick strand as the one whose 5\u0027-end is on the long arm.", - "enum": [ - "watson", - "crick" - ] - }, - "_strand": { - "description": "Extensions for strand", - "$ref": "#/definitions/Element" - }, - "windowStart": { - "description": "Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.", - "$ref": "#/definitions/integer" - }, - "_windowStart": { - "description": "Extensions for windowStart", - "$ref": "#/definitions/Element" - }, - "windowEnd": { - "description": "End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.", - "$ref": "#/definitions/integer" - }, - "_windowEnd": { - "description": "Extensions for windowEnd", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Variant": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "start": { - "description": "Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.", - "$ref": "#/definitions/integer" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.", - "$ref": "#/definitions/integer" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "observedAllele": { - "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.", - "$ref": "#/definitions/string" - }, - "_observedAllele": { - "description": "Extensions for observedAllele", - "$ref": "#/definitions/Element" - }, - "referenceAllele": { - "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.", - "$ref": "#/definitions/string" - }, - "_referenceAllele": { - "description": "Extensions for referenceAllele", - "$ref": "#/definitions/Element" - }, - "cigar": { - "description": "Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).", - "$ref": "#/definitions/string" - }, - "_cigar": { - "description": "Extensions for cigar", - "$ref": "#/definitions/Element" - }, - "variantPointer": { - "description": "A pointer to an Observation containing variant information.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Quality": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "INDEL / SNP / Undefined variant.", - "enum": [ - "indel", - "snp", - "unknown" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "standardSequence": { - "description": "Gold standard sequence used for comparing against.", - "$ref": "#/definitions/CodeableConcept" - }, - "start": { - "description": "Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.", - "$ref": "#/definitions/integer" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.", - "$ref": "#/definitions/integer" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "score": { - "description": "The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).", - "$ref": "#/definitions/Quantity" - }, - "method": { - "description": "Which method is used to get sequence quality.", - "$ref": "#/definitions/CodeableConcept" - }, - "truthTP": { - "description": "True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.", - "$ref": "#/definitions/decimal" - }, - "_truthTP": { - "description": "Extensions for truthTP", - "$ref": "#/definitions/Element" - }, - "queryTP": { - "description": "True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.", - "$ref": "#/definitions/decimal" - }, - "_queryTP": { - "description": "Extensions for queryTP", - "$ref": "#/definitions/Element" - }, - "truthFN": { - "description": "False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.", - "$ref": "#/definitions/decimal" - }, - "_truthFN": { - "description": "Extensions for truthFN", - "$ref": "#/definitions/Element" - }, - "queryFP": { - "description": "False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.", - "$ref": "#/definitions/decimal" - }, - "_queryFP": { - "description": "Extensions for queryFP", - "$ref": "#/definitions/Element" - }, - "gtFP": { - "description": "The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).", - "$ref": "#/definitions/decimal" - }, - "_gtFP": { - "description": "Extensions for gtFP", - "$ref": "#/definitions/Element" - }, - "precision": { - "description": "QUERY.TP / (QUERY.TP + QUERY.FP).", - "$ref": "#/definitions/decimal" - }, - "_precision": { - "description": "Extensions for precision", - "$ref": "#/definitions/Element" - }, - "recall": { - "description": "TRUTH.TP / (TRUTH.TP + TRUTH.FN).", - "$ref": "#/definitions/decimal" - }, - "_recall": { - "description": "Extensions for recall", - "$ref": "#/definitions/Element" - }, - "fScore": { - "description": "Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).", - "$ref": "#/definitions/decimal" - }, - "_fScore": { - "description": "Extensions for fScore", - "$ref": "#/definitions/Element" - }, - "roc": { - "description": "Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.", - "$ref": "#/definitions/MolecularSequence_Roc" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Roc": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "score": { - "description": "Invidual data point representing the GQ (genotype quality) score threshold.", - "items": { - "$ref": "#/definitions/integer" - }, - "type": "array" - }, - "_score": { - "description": "Extensions for score", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "numTP": { - "description": "The number of true positives if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/integer" - }, - "type": "array" - }, - "_numTP": { - "description": "Extensions for numTP", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "numFP": { - "description": "The number of false positives if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/integer" - }, - "type": "array" - }, - "_numFP": { - "description": "Extensions for numFP", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "numFN": { - "description": "The number of false negatives if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/integer" - }, - "type": "array" - }, - "_numFN": { - "description": "Extensions for numFN", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "precision": { - "description": "Calculated precision if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/decimal" - }, - "type": "array" - }, - "_precision": { - "description": "Extensions for precision", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "sensitivity": { - "description": "Calculated sensitivity if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/decimal" - }, - "type": "array" - }, - "_sensitivity": { - "description": "Extensions for sensitivity", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "fMeasure": { - "description": "Calculated fScore if the GQ score threshold was set to \"score\" field value.", - "items": { - "$ref": "#/definitions/decimal" - }, - "type": "array" - }, - "_fMeasure": { - "description": "Extensions for fMeasure", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Repository": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.", - "enum": [ - "directlink", - "openapi", - "login", - "oauth", - "other" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "URI of an external repository which contains further details about the genetics data.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "URI of an external repository which contains further details about the genetics data.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "datasetId": { - "description": "Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.", - "$ref": "#/definitions/string" - }, - "_datasetId": { - "description": "Extensions for datasetId", - "$ref": "#/definitions/Element" - }, - "variantsetId": { - "description": "Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.", - "$ref": "#/definitions/string" - }, - "_variantsetId": { - "description": "Extensions for variantsetId", - "$ref": "#/definitions/Element" - }, - "readsetId": { - "description": "Id of the read in this external repository.", - "$ref": "#/definitions/string" - }, - "_readsetId": { - "description": "Extensions for readsetId", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MolecularSequence_StructureVariant": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "variantType": { - "description": "Information about chromosome structure variation DNA change type.", - "$ref": "#/definitions/CodeableConcept" - }, - "exact": { - "description": "Used to indicate if the outer and inner start-end values have the same meaning.", - "$ref": "#/definitions/boolean" - }, - "_exact": { - "description": "Extensions for exact", - "$ref": "#/definitions/Element" - }, - "length": { - "description": "Length of the variant chromosome.", - "$ref": "#/definitions/integer" - }, - "_length": { - "description": "Extensions for length", - "$ref": "#/definitions/Element" - }, - "outer": { - "description": "Structural variant outer.", - "$ref": "#/definitions/MolecularSequence_Outer" - }, - "inner": { - "description": "Structural variant inner.", - "$ref": "#/definitions/MolecularSequence_Inner" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Outer": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "start": { - "description": "Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.", - "$ref": "#/definitions/integer" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.", - "$ref": "#/definitions/integer" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "MolecularSequence_Inner": { - "description": "Raw data describing a biological sequence.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "start": { - "description": "Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive.", - "$ref": "#/definitions/integer" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.", - "$ref": "#/definitions/integer" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "NamingSystem": { - "description": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.", - "properties": { - "resourceType": { - "description": "This is a NamingSystem resource", - "const": "NamingSystem" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this naming system. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "kind": { - "description": "Indicates the purpose for the naming system - what kinds of things does it make unique?", - "enum": [ - "codesystem", - "identifier", - "root" - ] - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the naming system.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "responsible": { - "description": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.", - "$ref": "#/definitions/string" - }, - "_responsible": { - "description": "Extensions for responsible", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Categorizes a naming system for easier search by grouping related naming systems.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "A free text natural language description of the naming system from a consumer\u0027s perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the naming system is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "usage": { - "description": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "uniqueId": { - "description": "Indicates how the system may be identified when referenced in electronic exchange.", - "items": { - "$ref": "#/definitions/NamingSystem_UniqueId" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "uniqueId", - "resourceType" - ] - }, - "NamingSystem_UniqueId": { - "description": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Identifies the unique identifier scheme used for this particular identifier.", - "enum": [ - "oid", - "uuid", - "uri", - "other" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The string that should be sent over the wire to identify the code system or identifier system.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "preferred": { - "description": "Indicates whether this identifier is the \"preferred\" identifier of this type.", - "$ref": "#/definitions/boolean" - }, - "_preferred": { - "description": "Extensions for preferred", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Notes about the past or intended usage of this identifier.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "NutritionOrder": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "resourceType": { - "description": "This is a NutritionOrder resource", - "const": "NutritionOrder" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this order by the order sender or by the order receiver.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "instantiates": { - "description": "The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiates": { - "description": "Extensions for instantiates", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "status": { - "description": "The workflow status of the nutrition order/request.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "intent": { - "description": "Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "An encounter that provides additional information about the healthcare context in which this request is made.", - "$ref": "#/definitions/Reference" - }, - "dateTime": { - "description": "The date and time that this nutrition order was requested.", - "$ref": "#/definitions/dateTime" - }, - "_dateTime": { - "description": "Extensions for dateTime", - "$ref": "#/definitions/Element" - }, - "orderer": { - "description": "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.", - "$ref": "#/definitions/Reference" - }, - "allergyIntolerance": { - "description": "A link to a record of allergies or intolerances which should be included in the nutrition order.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "foodPreferenceModifier": { - "description": "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "excludeFoodModifier": { - "description": "This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "oralDiet": { - "description": "Diet given orally in contrast to enteral (tube) feeding.", - "$ref": "#/definitions/NutritionOrder_OralDiet" - }, - "supplement": { - "description": "Oral nutritional products given in order to add further nutritional value to the patient\u0027s diet.", - "items": { - "$ref": "#/definitions/NutritionOrder_Supplement" - }, - "type": "array" - }, - "enteralFormula": { - "description": "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.", - "$ref": "#/definitions/NutritionOrder_EnteralFormula" - }, - "note": { - "description": "Comments made about the {{title}} by the requester, performer, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "resourceType" - ] - }, - "NutritionOrder_OralDiet": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "schedule": { - "description": "The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.", - "items": { - "$ref": "#/definitions/Timing" - }, - "type": "array" - }, - "nutrient": { - "description": "Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.", - "items": { - "$ref": "#/definitions/NutritionOrder_Nutrient" - }, - "type": "array" - }, - "texture": { - "description": "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.", - "items": { - "$ref": "#/definitions/NutritionOrder_Texture" - }, - "type": "array" - }, - "fluidConsistencyType": { - "description": "The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "instruction": { - "description": "Free text or additional instructions or information pertaining to the oral diet.", - "$ref": "#/definitions/string" - }, - "_instruction": { - "description": "Extensions for instruction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "NutritionOrder_Nutrient": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifier": { - "description": "The nutrient that is being modified such as carbohydrate or sodium.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "The quantity of the specified nutrient to include in diet.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "NutritionOrder_Texture": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifier": { - "description": "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.", - "$ref": "#/definitions/CodeableConcept" - }, - "foodType": { - "description": "The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "NutritionOrder_Supplement": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.", - "$ref": "#/definitions/CodeableConcept" - }, - "productName": { - "description": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".", - "$ref": "#/definitions/string" - }, - "_productName": { - "description": "Extensions for productName", - "$ref": "#/definitions/Element" - }, - "schedule": { - "description": "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.", - "items": { - "$ref": "#/definitions/Timing" - }, - "type": "array" - }, - "quantity": { - "description": "The amount of the nutritional supplement to be given.", - "$ref": "#/definitions/Quantity" - }, - "instruction": { - "description": "Free text or additional instructions or information pertaining to the oral supplement.", - "$ref": "#/definitions/string" - }, - "_instruction": { - "description": "Extensions for instruction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "NutritionOrder_EnteralFormula": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "baseFormulaType": { - "description": "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.", - "$ref": "#/definitions/CodeableConcept" - }, - "baseFormulaProductName": { - "description": "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".", - "$ref": "#/definitions/string" - }, - "_baseFormulaProductName": { - "description": "Extensions for baseFormulaProductName", - "$ref": "#/definitions/Element" - }, - "additiveType": { - "description": "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.", - "$ref": "#/definitions/CodeableConcept" - }, - "additiveProductName": { - "description": "The product or brand name of the type of modular component to be added to the formula.", - "$ref": "#/definitions/string" - }, - "_additiveProductName": { - "description": "Extensions for additiveProductName", - "$ref": "#/definitions/Element" - }, - "caloricDensity": { - "description": "The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.", - "$ref": "#/definitions/Quantity" - }, - "routeofAdministration": { - "description": "The route or physiological path of administration into the patient\u0027s gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.", - "$ref": "#/definitions/CodeableConcept" - }, - "administration": { - "description": "Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.", - "items": { - "$ref": "#/definitions/NutritionOrder_Administration" - }, - "type": "array" - }, - "maxVolumeToDeliver": { - "description": "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.", - "$ref": "#/definitions/Quantity" - }, - "administrationInstruction": { - "description": "Free text formula administration, feeding instructions or additional instructions or information.", - "$ref": "#/definitions/string" - }, - "_administrationInstruction": { - "description": "Extensions for administrationInstruction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "NutritionOrder_Administration": { - "description": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "schedule": { - "description": "The time period and frequency at which the enteral formula should be delivered to the patient.", - "$ref": "#/definitions/Timing" - }, - "quantity": { - "description": "The volume of formula to provide to the patient per the specified administration schedule.", - "$ref": "#/definitions/Quantity" - }, - "rateQuantity": { - "description": "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.", - "$ref": "#/definitions/Quantity" - }, - "rateRatio": { - "description": "The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.", - "$ref": "#/definitions/Ratio" - } - }, - "additionalProperties": false - }, - "Observation": { - "description": "Measurements and simple assertions made about a patient, device or other subject.", - "properties": { - "resourceType": { - "description": "This is a Observation resource", - "const": "Observation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this observation.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The status of the result value.", - "enum": [ - "registered", - "preliminary", - "final", - "amended", - "corrected", - "cancelled", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "A code that classifies the general type of observation being made.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "code": { - "description": "Describes what was observed. Sometimes this is called the observation \"name\".", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.", - "$ref": "#/definitions/Reference" - }, - "focus": { - "description": "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother\u0027s record. The focus of an observation could also be an existing condition, an intervention, the subject\u0027s diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child\u0027s tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "encounter": { - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", - "$ref": "#/definitions/Reference" - }, - "effectiveDateTime": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_effectiveDateTime": { - "description": "Extensions for effectiveDateTime", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "$ref": "#/definitions/Period" - }, - "effectiveTiming": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "$ref": "#/definitions/Timing" - }, - "effectiveInstant": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_effectiveInstant": { - "description": "Extensions for effectiveInstant", - "$ref": "#/definitions/Element" - }, - "issued": { - "description": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", - "$ref": "#/definitions/instant" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "performer": { - "description": "Who was responsible for asserting the observed value as \"true\".", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "valueQuantity": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Quantity" - }, - "valueCodeableConcept": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueString": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueRange": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Ratio" - }, - "valueSampledData": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/SampledData" - }, - "valueTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valuePeriod": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Period" - }, - "dataAbsentReason": { - "description": "Provides a reason why the expected value in the element Observation.value[x] is missing.", - "$ref": "#/definitions/CodeableConcept" - }, - "interpretation": { - "description": "A categorical assessment of an observation value. For example, high, low, normal.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "Comments about the observation or the results.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "bodySite": { - "description": "Indicates the site on the subject\u0027s body where the observation was made (i.e. the target site).", - "$ref": "#/definitions/CodeableConcept" - }, - "method": { - "description": "Indicates the mechanism used to perform the observation.", - "$ref": "#/definitions/CodeableConcept" - }, - "specimen": { - "description": "The specimen that was used when this observation was made.", - "$ref": "#/definitions/Reference" - }, - "device": { - "description": "The device used to generate the observation data.", - "$ref": "#/definitions/Reference" - }, - "referenceRange": { - "description": "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", - "items": { - "$ref": "#/definitions/Observation_ReferenceRange" - }, - "type": "array" - }, - "hasMember": { - "description": "This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "derivedFrom": { - "description": "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "component": { - "description": "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.", - "items": { - "$ref": "#/definitions/Observation_Component" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code", - "resourceType" - ] - }, - "Observation_ReferenceRange": { - "description": "Measurements and simple assertions made about a patient, device or other subject.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "low": { - "description": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is \u003e\u003d5 - \u003c\u003d9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is \u003c\u003d2.3).", - "$ref": "#/definitions/Quantity" - }, - "high": { - "description": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is \u003e\u003d5 - \u003c\u003d9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is \u003e\u003d 2.3).", - "$ref": "#/definitions/Quantity" - }, - "type": { - "description": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", - "$ref": "#/definitions/CodeableConcept" - }, - "appliesTo": { - "description": "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "age": { - "description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", - "$ref": "#/definitions/Range" - }, - "text": { - "description": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Observation_Component": { - "description": "Measurements and simple assertions made about a patient, device or other subject.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Describes what was observed. Sometimes this is called the observation \"code\".", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Quantity" - }, - "valueCodeableConcept": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueString": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueRange": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Ratio" - }, - "valueSampledData": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/SampledData" - }, - "valueTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valuePeriod": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", - "$ref": "#/definitions/Period" - }, - "dataAbsentReason": { - "description": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", - "$ref": "#/definitions/CodeableConcept" - }, - "interpretation": { - "description": "A categorical assessment of an observation value. For example, high, low, normal.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "referenceRange": { - "description": "Guidance on how to interpret the value by comparison to a normal or recommended range.", - "items": { - "$ref": "#/definitions/Observation_ReferenceRange" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "ObservationDefinition": { - "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.", - "properties": { - "resourceType": { - "description": "This is a ObservationDefinition resource", - "const": "ObservationDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A code that classifies the general type of observation.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "code": { - "description": "Describes what will be observed. Sometimes this is called the observation \"name\".", - "$ref": "#/definitions/CodeableConcept" - }, - "identifier": { - "description": "A unique identifier assigned to this ObservationDefinition artifact.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "permittedDataType": { - "description": "The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.", - "items": { - "enum": [ - "Quantity", - "CodeableConcept", - "string", - "boolean", - "integer", - "Range", - "Ratio", - "SampledData", - "time", - "dateTime", - "Period" - ] - }, - "type": "array" - }, - "_permittedDataType": { - "description": "Extensions for permittedDataType", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "multipleResultsAllowed": { - "description": "Multiple results allowed for observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/boolean" - }, - "_multipleResultsAllowed": { - "description": "Extensions for multipleResultsAllowed", - "$ref": "#/definitions/Element" - }, - "method": { - "description": "The method or technique used to perform the observation.", - "$ref": "#/definitions/CodeableConcept" - }, - "preferredReportName": { - "description": "The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/string" - }, - "_preferredReportName": { - "description": "Extensions for preferredReportName", - "$ref": "#/definitions/Element" - }, - "quantitativeDetails": { - "description": "Characteristics for quantitative results of this observation.", - "$ref": "#/definitions/ObservationDefinition_QuantitativeDetails" - }, - "qualifiedInterval": { - "description": "Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.", - "items": { - "$ref": "#/definitions/ObservationDefinition_QualifiedInterval" - }, - "type": "array" - }, - "validCodedValueSet": { - "description": "The set of valid coded results for the observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/Reference" - }, - "normalCodedValueSet": { - "description": "The set of normal coded results for the observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/Reference" - }, - "abnormalCodedValueSet": { - "description": "The set of abnormal coded results for the observation conforming to this ObservationDefinition.", - "$ref": "#/definitions/Reference" - }, - "criticalCodedValueSet": { - "description": "The set of critical coded results for the observation conforming to this ObservationDefinition.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "code", - "resourceType" - ] - }, - "ObservationDefinition_QuantitativeDetails": { - "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "customaryUnit": { - "description": "Customary unit used to report quantitative results of observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/CodeableConcept" - }, - "unit": { - "description": "SI unit used to report quantitative results of observations conforming to this ObservationDefinition.", - "$ref": "#/definitions/CodeableConcept" - }, - "conversionFactor": { - "description": "Factor for converting value expressed with SI unit to value expressed with customary unit.", - "$ref": "#/definitions/decimal" - }, - "_conversionFactor": { - "description": "Extensions for conversionFactor", - "$ref": "#/definitions/Element" - }, - "decimalPrecision": { - "description": "Number of digits after decimal separator when the results of such observations are of type Quantity.", - "$ref": "#/definitions/integer" - }, - "_decimalPrecision": { - "description": "Extensions for decimalPrecision", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ObservationDefinition_QualifiedInterval": { - "description": "Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.", - "enum": [ - "reference", - "critical", - "absolute" - ] - }, - "_category": { - "description": "Extensions for category", - "$ref": "#/definitions/Element" - }, - "range": { - "description": "The low and high values determining the interval. There may be only one of the two.", - "$ref": "#/definitions/Range" - }, - "context": { - "description": "Codes to indicate the health context the range applies to. For example, the normal or therapeutic range.", - "$ref": "#/definitions/CodeableConcept" - }, - "appliesTo": { - "description": "Codes to indicate the target population this reference range applies to.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "gender": { - "description": "Sex of the population the range applies to.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "age": { - "description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", - "$ref": "#/definitions/Range" - }, - "gestationalAge": { - "description": "The gestational age to which this reference range is applicable, in the context of pregnancy.", - "$ref": "#/definitions/Range" - }, - "condition": { - "description": "Text based condition for which the reference range is valid.", - "$ref": "#/definitions/string" - }, - "_condition": { - "description": "Extensions for condition", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "OperationDefinition": { - "description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).", - "properties": { - "resourceType": { - "description": "This is a OperationDefinition resource", - "const": "OperationDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the operation definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this operation definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "kind": { - "description": "Whether this is an operation or a named query.", - "enum": [ - "operation", - "query" - ] - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the operation definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the operation definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the operation definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this operation definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "affectsState": { - "description": "Whether the operation affects state. Side effects such as producing audit trail entries do not count as \u0027affecting state\u0027.", - "$ref": "#/definitions/boolean" - }, - "_affectsState": { - "description": "Extensions for affectsState", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "The name used to invoke the operation.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Additional information about how to use this operation or named query.", - "$ref": "#/definitions/markdown" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "base": { - "description": "Indicates that this operation definition is a constraining profile on the base.", - "$ref": "#/definitions/canonical" - }, - "resource": { - "description": "The types on which this operation can be executed.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_resource": { - "description": "Extensions for resource", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "system": { - "description": "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).", - "$ref": "#/definitions/boolean" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).", - "$ref": "#/definitions/boolean" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "instance": { - "description": "Indicates whether this operation can be invoked on a particular instance of one of the given types.", - "$ref": "#/definitions/boolean" - }, - "_instance": { - "description": "Extensions for instance", - "$ref": "#/definitions/Element" - }, - "inputProfile": { - "description": "Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.", - "$ref": "#/definitions/canonical" - }, - "outputProfile": { - "description": "Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.", - "$ref": "#/definitions/canonical" - }, - "parameter": { - "description": "The parameters for the operation/query.", - "items": { - "$ref": "#/definitions/OperationDefinition_Parameter" - }, - "type": "array" - }, - "overload": { - "description": "Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.", - "items": { - "$ref": "#/definitions/OperationDefinition_Overload" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "OperationDefinition_Parameter": { - "description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of used to identify the parameter.", - "$ref": "#/definitions/code" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "use": { - "description": "Whether this is an input or an output parameter.", - "enum": [ - "in", - "out" - ] - }, - "_use": { - "description": "Extensions for use", - "$ref": "#/definitions/Element" - }, - "min": { - "description": "The minimum number of times this parameter SHALL appear in the request or response.", - "$ref": "#/definitions/integer" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "The maximum number of times this element is permitted to appear in the request or response.", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Describes the meaning or use of this parameter.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type for this parameter.", - "$ref": "#/definitions/code" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "targetProfile": { - "description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "searchType": { - "description": "How the parameter is understood as a search parameter. This is only used if the parameter type is \u0027string\u0027.", - "enum": [ - "number", - "date", - "string", - "token", - "reference", - "composite", - "quantity", - "uri", - "special" - ] - }, - "_searchType": { - "description": "Extensions for searchType", - "$ref": "#/definitions/Element" - }, - "binding": { - "description": "Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).", - "$ref": "#/definitions/OperationDefinition_Binding" - }, - "referencedFrom": { - "description": "Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.", - "items": { - "$ref": "#/definitions/OperationDefinition_ReferencedFrom" - }, - "type": "array" - }, - "part": { - "description": "The parts of a nested Parameter.", - "items": { - "$ref": "#/definitions/OperationDefinition_Parameter" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "OperationDefinition_Binding": { - "description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "strength": { - "description": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.", - "enum": [ - "required", - "extensible", - "preferred", - "example" - ] - }, - "_strength": { - "description": "Extensions for strength", - "$ref": "#/definitions/Element" - }, - "valueSet": { - "description": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "valueSet" - ] - }, - "OperationDefinition_ReferencedFrom": { - "description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "source": { - "description": "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.", - "$ref": "#/definitions/string" - }, - "_source": { - "description": "Extensions for source", - "$ref": "#/definitions/Element" - }, - "sourceId": { - "description": "The id of the element in the referencing resource that is expected to resolve to this resource.", - "$ref": "#/definitions/string" - }, - "_sourceId": { - "description": "Extensions for sourceId", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "OperationDefinition_Overload": { - "description": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "parameterName": { - "description": "Name of parameter to include in overload.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_parameterName": { - "description": "Extensions for parameterName", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "comment": { - "description": "Comments to go on overload.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "OperationOutcome": { - "description": "A collection of error, warning, or information messages that result from a system action.", - "properties": { - "resourceType": { - "description": "This is a OperationOutcome resource", - "const": "OperationOutcome" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "issue": { - "description": "An error, warning, or information message that results from a system action.", - "items": { - "$ref": "#/definitions/OperationOutcome_Issue" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "issue", - "resourceType" - ] - }, - "OperationOutcome_Issue": { - "description": "A collection of error, warning, or information messages that result from a system action.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "severity": { - "description": "Indicates whether the issue indicates a variation from successful processing.", - "enum": [ - "fatal", - "error", - "warning", - "information" - ] - }, - "_severity": { - "description": "Extensions for severity", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.", - "enum": [ - "invalid", - "structure", - "required", - "value", - "invariant", - "security", - "login", - "unknown", - "expired", - "forbidden", - "suppressed", - "processing", - "not-supported", - "duplicate", - "multiple-matches", - "not-found", - "deleted", - "too-long", - "code-invalid", - "extension", - "too-costly", - "business-rule", - "conflict", - "transient", - "lock-error", - "no-store", - "exception", - "timeout", - "incomplete", - "throttled", - "informational" - ] - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "details": { - "description": "Additional details about the error. This may be a text description of the error or a system code that identifies the error.", - "$ref": "#/definitions/CodeableConcept" - }, - "diagnostics": { - "description": "Additional diagnostic information about the issue.", - "$ref": "#/definitions/string" - }, - "_diagnostics": { - "description": "Extensions for diagnostics", - "$ref": "#/definitions/Element" - }, - "location": { - "description": "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_location": { - "description": "Extensions for location", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "expression": { - "description": "A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_expression": { - "description": "Extensions for expression", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Organization": { - "description": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.", - "properties": { - "resourceType": { - "description": "This is a Organization resource", - "const": "Organization" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether the organization\u0027s record is still in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind(s) of organization that this is.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "name": { - "description": "A name associated with the organization.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "A list of alternate names that the organization is known as, or was known as in the past.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_alias": { - "description": "Extensions for alias", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "telecom": { - "description": "A contact detail for the organization.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "An address for the organization.", - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array" - }, - "partOf": { - "description": "The organization of which this organization forms a part.", - "$ref": "#/definitions/Reference" - }, - "contact": { - "description": "Contact for the organization for a certain purpose.", - "items": { - "$ref": "#/definitions/Organization_Contact" - }, - "type": "array" - }, - "endpoint": { - "description": "Technical endpoints providing access to services operated for the organization.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Organization_Contact": { - "description": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "purpose": { - "description": "Indicates a purpose for which the contact can be reached.", - "$ref": "#/definitions/CodeableConcept" - }, - "name": { - "description": "A name associated with the contact.", - "$ref": "#/definitions/HumanName" - }, - "telecom": { - "description": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "Visiting or postal addresses for the contact.", - "$ref": "#/definitions/Address" - } - }, - "additionalProperties": false - }, - "OrganizationAffiliation": { - "description": "Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.", - "properties": { - "resourceType": { - "description": "This is a OrganizationAffiliation resource", - "const": "OrganizationAffiliation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers that are specific to this role.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this organization affiliation record is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period during which the participatingOrganization is affiliated with the primary organization.", - "$ref": "#/definitions/Period" - }, - "organization": { - "description": "Organization where the role is available (primary organization/has members).", - "$ref": "#/definitions/Reference" - }, - "participatingOrganization": { - "description": "The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).", - "$ref": "#/definitions/Reference" - }, - "network": { - "description": "Health insurance provider network in which the participatingOrganization provides the role\u0027s services (if defined) at the indicated locations (if defined).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "code": { - "description": "Definition of the role the participatingOrganization plays in the association.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "Specific specialty of the participatingOrganization in the context of the role.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "location": { - "description": "The location(s) at which the role occurs.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "healthcareService": { - "description": "Healthcare services provided through the role.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "telecom": { - "description": "Contact details at the participatingOrganization relevant to this Affiliation.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "endpoint": { - "description": "Technical endpoints providing access to services operated for this role.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Parameters": { - "description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", - "properties": { - "resourceType": { - "description": "This is a Parameters resource", - "const": "Parameters" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "parameter": { - "description": "A parameter passed to or received from the operation.", - "items": { - "$ref": "#/definitions/Parameters_Parameter" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Parameters_Parameter": { - "description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of the parameter (reference to the operation definition).", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "valueBase64Binary": { - "description": "If the parameter is a data type.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "If the parameter is a data type.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueCanonical": { - "description": "If the parameter is a data type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueCanonical": { - "description": "Extensions for valueCanonical", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "If the parameter is a data type.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "If the parameter is a data type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "If the parameter is a data type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "If the parameter is a data type.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueId": { - "description": "If the parameter is a data type.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueInstant": { - "description": "If the parameter is a data type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_valueInstant": { - "description": "Extensions for valueInstant", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "If the parameter is a data type.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueMarkdown": { - "description": "If the parameter is a data type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueMarkdown": { - "description": "Extensions for valueMarkdown", - "$ref": "#/definitions/Element" - }, - "valueOid": { - "description": "If the parameter is a data type.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_valueOid": { - "description": "Extensions for valueOid", - "$ref": "#/definitions/Element" - }, - "valuePositiveInt": { - "description": "If the parameter is a data type.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_valuePositiveInt": { - "description": "Extensions for valuePositiveInt", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "If the parameter is a data type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "If the parameter is a data type.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueUnsignedInt": { - "description": "If the parameter is a data type.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_valueUnsignedInt": { - "description": "Extensions for valueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "If the parameter is a data type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueUrl": { - "description": "If the parameter is a data type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUrl": { - "description": "Extensions for valueUrl", - "$ref": "#/definitions/Element" - }, - "valueUuid": { - "description": "If the parameter is a data type.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_valueUuid": { - "description": "Extensions for valueUuid", - "$ref": "#/definitions/Element" - }, - "valueAddress": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Address" - }, - "valueAge": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Age" - }, - "valueAnnotation": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Annotation" - }, - "valueAttachment": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Attachment" - }, - "valueCodeableConcept": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCoding": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Coding" - }, - "valueContactPoint": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/ContactPoint" - }, - "valueCount": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Count" - }, - "valueDistance": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Distance" - }, - "valueDuration": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Duration" - }, - "valueHumanName": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/HumanName" - }, - "valueIdentifier": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Identifier" - }, - "valueMoney": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Money" - }, - "valuePeriod": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Period" - }, - "valueQuantity": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Ratio" - }, - "valueReference": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Reference" - }, - "valueSampledData": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/SampledData" - }, - "valueSignature": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Signature" - }, - "valueTiming": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Timing" - }, - "valueContactDetail": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/ContactDetail" - }, - "valueContributor": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Contributor" - }, - "valueDataRequirement": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/DataRequirement" - }, - "valueExpression": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Expression" - }, - "valueParameterDefinition": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/ParameterDefinition" - }, - "valueRelatedArtifact": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/RelatedArtifact" - }, - "valueTriggerDefinition": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/TriggerDefinition" - }, - "valueUsageContext": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/UsageContext" - }, - "valueDosage": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Dosage" - }, - "valueMeta": { - "description": "If the parameter is a data type.", - "$ref": "#/definitions/Meta" - }, - "resource": { - "description": "If the parameter is a whole resource.", - "$ref": "#/definitions/ResourceList" - }, - "part": { - "description": "A named part of a multi-part parameter.", - "items": { - "$ref": "#/definitions/Parameters_Parameter" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Patient": { - "description": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", - "properties": { - "resourceType": { - "description": "This is a Patient resource", - "const": "Patient" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An identifier for this patient.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this patient record is in active use. \nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization\u0027s business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A name associated with the individual.", - "items": { - "$ref": "#/definitions/HumanName" - }, - "type": "array" - }, - "telecom": { - "description": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "gender": { - "description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "birthDate": { - "description": "The date of birth for the individual.", - "$ref": "#/definitions/date" - }, - "_birthDate": { - "description": "Extensions for birthDate", - "$ref": "#/definitions/Element" - }, - "deceasedBoolean": { - "description": "Indicates if the individual is deceased or not.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_deceasedBoolean": { - "description": "Extensions for deceasedBoolean", - "$ref": "#/definitions/Element" - }, - "deceasedDateTime": { - "description": "Indicates if the individual is deceased or not.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_deceasedDateTime": { - "description": "Extensions for deceasedDateTime", - "$ref": "#/definitions/Element" - }, - "address": { - "description": "An address for the individual.", - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array" - }, - "maritalStatus": { - "description": "This field contains a patient\u0027s most recent marital (civil) status.", - "$ref": "#/definitions/CodeableConcept" - }, - "multipleBirthBoolean": { - "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", - "pattern": "^true|false$", - "type": "boolean" - }, - "_multipleBirthBoolean": { - "description": "Extensions for multipleBirthBoolean", - "$ref": "#/definitions/Element" - }, - "multipleBirthInteger": { - "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_multipleBirthInteger": { - "description": "Extensions for multipleBirthInteger", - "$ref": "#/definitions/Element" - }, - "photo": { - "description": "Image of the patient.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - }, - "contact": { - "description": "A contact party (e.g. guardian, partner, friend) for the patient.", - "items": { - "$ref": "#/definitions/Patient_Contact" - }, - "type": "array" - }, - "communication": { - "description": "A language which may be used to communicate with the patient about his or her health.", - "items": { - "$ref": "#/definitions/Patient_Communication" - }, - "type": "array" - }, - "generalPractitioner": { - "description": "Patient\u0027s nominated care provider.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "managingOrganization": { - "description": "Organization that is the custodian of the patient record.", - "$ref": "#/definitions/Reference" - }, - "link": { - "description": "Link to another patient resource that concerns the same actual patient.", - "items": { - "$ref": "#/definitions/Patient_Link" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Patient_Contact": { - "description": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "relationship": { - "description": "The nature of the relationship between the patient and the contact person.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "name": { - "description": "A name associated with the contact person.", - "$ref": "#/definitions/HumanName" - }, - "telecom": { - "description": "A contact detail for the person, e.g. a telephone number or an email address.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "Address for the contact person.", - "$ref": "#/definitions/Address" - }, - "gender": { - "description": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "organization": { - "description": "Organization on behalf of which the contact is acting or for which the contact is working.", - "$ref": "#/definitions/Reference" - }, - "period": { - "description": "The period during which this contact person or organization is valid to be contacted relating to this patient.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "Patient_Communication": { - "description": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "language": { - "description": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.", - "$ref": "#/definitions/CodeableConcept" - }, - "preferred": { - "description": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", - "$ref": "#/definitions/boolean" - }, - "_preferred": { - "description": "Extensions for preferred", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "language" - ] - }, - "Patient_Link": { - "description": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "other": { - "description": "The other patient resource that the link refers to.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "The type of link between this patient resource and another patient resource.", - "enum": [ - "replaced-by", - "replaces", - "refer", - "seealso" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "other" - ] - }, - "PaymentNotice": { - "description": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.", - "properties": { - "resourceType": { - "description": "This is a PaymentNotice resource", - "const": "PaymentNotice" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this payment notice.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "request": { - "description": "Reference of resource for which payment is being made.", - "$ref": "#/definitions/Reference" - }, - "response": { - "description": "Reference of response to resource for which payment is being made.", - "$ref": "#/definitions/Reference" - }, - "created": { - "description": "The date when this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "provider": { - "description": "The practitioner who is responsible for the services rendered to the patient.", - "$ref": "#/definitions/Reference" - }, - "payment": { - "description": "A reference to the payment which is the subject of this notice.", - "$ref": "#/definitions/Reference" - }, - "paymentDate": { - "description": "The date when the above payment action occurred.", - "$ref": "#/definitions/date" - }, - "_paymentDate": { - "description": "Extensions for paymentDate", - "$ref": "#/definitions/Element" - }, - "payee": { - "description": "The party who will receive or has received payment that is the subject of this notification.", - "$ref": "#/definitions/Reference" - }, - "recipient": { - "description": "The party who is notified of the payment status.", - "$ref": "#/definitions/Reference" - }, - "amount": { - "description": "The amount sent to the payee.", - "$ref": "#/definitions/Money" - }, - "paymentStatus": { - "description": "A code indicating whether payment has been sent or cleared.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false, - "required": [ - "amount", - "recipient", - "payment", - "resourceType" - ] - }, - "PaymentReconciliation": { - "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.", - "properties": { - "resourceType": { - "description": "This is a PaymentReconciliation resource", - "const": "PaymentReconciliation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this payment reconciliation.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period of time for which payments have been gathered into this bulk payment for settlement.", - "$ref": "#/definitions/Period" - }, - "created": { - "description": "The date when the resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "paymentIssuer": { - "description": "The party who generated the payment.", - "$ref": "#/definitions/Reference" - }, - "request": { - "description": "Original request resource reference.", - "$ref": "#/definitions/Reference" - }, - "requestor": { - "description": "The practitioner who is responsible for the services rendered to the patient.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "The outcome of a request for a reconciliation.", - "enum": [ - "queued", - "complete", - "error", - "partial" - ] - }, - "_outcome": { - "description": "Extensions for outcome", - "$ref": "#/definitions/Element" - }, - "disposition": { - "description": "A human readable description of the status of the request for the reconciliation.", - "$ref": "#/definitions/string" - }, - "_disposition": { - "description": "Extensions for disposition", - "$ref": "#/definitions/Element" - }, - "paymentDate": { - "description": "The date of payment as indicated on the financial instrument.", - "$ref": "#/definitions/date" - }, - "_paymentDate": { - "description": "Extensions for paymentDate", - "$ref": "#/definitions/Element" - }, - "paymentAmount": { - "description": "Total payment amount as indicated on the financial instrument.", - "$ref": "#/definitions/Money" - }, - "paymentIdentifier": { - "description": "Issuer\u0027s unique identifier for the payment instrument.", - "$ref": "#/definitions/Identifier" - }, - "detail": { - "description": "Distribution of the payment amount for a previously acknowledged payable.", - "items": { - "$ref": "#/definitions/PaymentReconciliation_Detail" - }, - "type": "array" - }, - "formCode": { - "description": "A code for the form to be used for printing the content.", - "$ref": "#/definitions/CodeableConcept" - }, - "processNote": { - "description": "A note that describes or explains the processing in a human readable form.", - "items": { - "$ref": "#/definitions/PaymentReconciliation_ProcessNote" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "paymentAmount", - "resourceType" - ] - }, - "PaymentReconciliation_Detail": { - "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for the current payment item for the referenced payable.", - "$ref": "#/definitions/Identifier" - }, - "predecessor": { - "description": "Unique identifier for the prior payment item for the referenced payable.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "Code to indicate the nature of the payment.", - "$ref": "#/definitions/CodeableConcept" - }, - "request": { - "description": "A resource, such as a Claim, the evaluation of which could lead to payment.", - "$ref": "#/definitions/Reference" - }, - "submitter": { - "description": "The party which submitted the claim or financial transaction.", - "$ref": "#/definitions/Reference" - }, - "response": { - "description": "A resource, such as a ClaimResponse, which contains a commitment to payment.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date from the response resource containing a commitment to pay.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "responsible": { - "description": "A reference to the individual who is responsible for inquiries regarding the response and its payment.", - "$ref": "#/definitions/Reference" - }, - "payee": { - "description": "The party which is receiving the payment.", - "$ref": "#/definitions/Reference" - }, - "amount": { - "description": "The monetary amount allocated from the total payment to the payable.", - "$ref": "#/definitions/Money" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "PaymentReconciliation_ProcessNote": { - "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The business purpose of the note text.", - "enum": [ - "display", - "print", - "printoper" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "The explanation or description associated with the processing.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Person": { - "description": "Demographics and administrative information about a person independent of a specific health-related context.", - "properties": { - "resourceType": { - "description": "This is a Person resource", - "const": "Person" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for a person within a particular scope.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "name": { - "description": "A name associated with the person.", - "items": { - "$ref": "#/definitions/HumanName" - }, - "type": "array" - }, - "telecom": { - "description": "A contact detail for the person, e.g. a telephone number or an email address.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "gender": { - "description": "Administrative Gender.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "birthDate": { - "description": "The birth date for the person.", - "$ref": "#/definitions/date" - }, - "_birthDate": { - "description": "Extensions for birthDate", - "$ref": "#/definitions/Element" - }, - "address": { - "description": "One or more addresses for the person.", - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array" - }, - "photo": { - "description": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.", - "$ref": "#/definitions/Attachment" - }, - "managingOrganization": { - "description": "The organization that is the custodian of the person record.", - "$ref": "#/definitions/Reference" - }, - "active": { - "description": "Whether this person\u0027s record is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "link": { - "description": "Link to a resource that concerns the same actual person.", - "items": { - "$ref": "#/definitions/Person_Link" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Person_Link": { - "description": "Demographics and administrative information about a person independent of a specific health-related context.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "target": { - "description": "The resource to which this actual person is associated.", - "$ref": "#/definitions/Reference" - }, - "assurance": { - "description": "Level of assurance that this link is associated with the target resource.", - "enum": [ - "level1", - "level2", - "level3", - "level4" - ] - }, - "_assurance": { - "description": "Extensions for assurance", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "target" - ] - }, - "PlanDefinition": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "resourceType": { - "description": "This is a PlanDefinition resource", - "const": "PlanDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the plan definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the plan definition giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The status of this plan definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "A code or group definition that describes the intended subject of the plan definition.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "A code or group definition that describes the intended subject of the plan definition.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the plan definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the plan definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the plan definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this plan definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description of how the plan definition is used from a clinical perspective.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the plan definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "library": { - "description": "A reference to a Library resource containing any formal logic used by the plan definition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "goal": { - "description": "Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.", - "items": { - "$ref": "#/definitions/PlanDefinition_Goal" - }, - "type": "array" - }, - "action": { - "description": "An action or group of actions to be taken as part of the plan.", - "items": { - "$ref": "#/definitions/PlanDefinition_Action" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "PlanDefinition_Goal": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "Indicates a category the goal falls within.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".", - "$ref": "#/definitions/CodeableConcept" - }, - "priority": { - "description": "Identifies the expected level of importance associated with reaching/sustaining the defined goal.", - "$ref": "#/definitions/CodeableConcept" - }, - "start": { - "description": "The event after which the goal should begin being pursued.", - "$ref": "#/definitions/CodeableConcept" - }, - "addresses": { - "description": "Identifies problems, conditions, issues, or concerns the goal is intended to address.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "documentation": { - "description": "Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "target": { - "description": "Indicates what should be done and within what timeframe.", - "items": { - "$ref": "#/definitions/PlanDefinition_Target" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "description" - ] - }, - "PlanDefinition_Target": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "measure": { - "description": "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", - "$ref": "#/definitions/CodeableConcept" - }, - "detailQuantity": { - "description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.", - "$ref": "#/definitions/Quantity" - }, - "detailRange": { - "description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.", - "$ref": "#/definitions/Range" - }, - "detailCodeableConcept": { - "description": "The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.", - "$ref": "#/definitions/CodeableConcept" - }, - "due": { - "description": "Indicates the timeframe after the start of the goal in which the goal should be met.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "PlanDefinition_Action": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "prefix": { - "description": "A user-visible prefix for the action.", - "$ref": "#/definitions/string" - }, - "_prefix": { - "description": "Extensions for prefix", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "The title of the action displayed to a user.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A brief description of the action used to provide a summary to display to the user.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "textEquivalent": { - "description": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.", - "$ref": "#/definitions/string" - }, - "_textEquivalent": { - "description": "Extensions for textEquivalent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the action should be addressed with respect to other actions.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reason": { - "description": "A description of why this action is necessary or appropriate.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "documentation": { - "description": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "goalId": { - "description": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.", - "items": { - "$ref": "#/definitions/id" - }, - "type": "array" - }, - "_goalId": { - "description": "Extensions for goalId", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "subjectCodeableConcept": { - "description": "A code or group definition that describes the intended subject of the action and its children, if any.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "A code or group definition that describes the intended subject of the action and its children, if any.", - "$ref": "#/definitions/Reference" - }, - "trigger": { - "description": "A description of when the action should be triggered.", - "items": { - "$ref": "#/definitions/TriggerDefinition" - }, - "type": "array" - }, - "condition": { - "description": "An expression that describes applicability criteria or start/stop conditions for the action.", - "items": { - "$ref": "#/definitions/PlanDefinition_Condition" - }, - "type": "array" - }, - "input": { - "description": "Defines input data requirements for the action.", - "items": { - "$ref": "#/definitions/DataRequirement" - }, - "type": "array" - }, - "output": { - "description": "Defines the outputs of the action, if any.", - "items": { - "$ref": "#/definitions/DataRequirement" - }, - "type": "array" - }, - "relatedAction": { - "description": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", - "items": { - "$ref": "#/definitions/PlanDefinition_RelatedAction" - }, - "type": "array" - }, - "timingDateTime": { - "description": "An optional value describing when the action should be performed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timingDateTime": { - "description": "Extensions for timingDateTime", - "$ref": "#/definitions/Element" - }, - "timingAge": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Age" - }, - "timingPeriod": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Period" - }, - "timingDuration": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Duration" - }, - "timingRange": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Range" - }, - "timingTiming": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Timing" - }, - "participant": { - "description": "Indicates who should participate in performing the action described.", - "items": { - "$ref": "#/definitions/PlanDefinition_Participant" - }, - "type": "array" - }, - "type": { - "description": "The type of action to perform (create, update, remove).", - "$ref": "#/definitions/CodeableConcept" - }, - "groupingBehavior": { - "description": "Defines the grouping behavior for the action and its children.", - "enum": [ - "visual-group", - "logical-group", - "sentence-group" - ] - }, - "_groupingBehavior": { - "description": "Extensions for groupingBehavior", - "$ref": "#/definitions/Element" - }, - "selectionBehavior": { - "description": "Defines the selection behavior for the action and its children.", - "enum": [ - "any", - "all", - "all-or-none", - "exactly-one", - "at-most-one", - "one-or-more" - ] - }, - "_selectionBehavior": { - "description": "Extensions for selectionBehavior", - "$ref": "#/definitions/Element" - }, - "requiredBehavior": { - "description": "Defines the required behavior for the action.", - "enum": [ - "must", - "could", - "must-unless-documented" - ] - }, - "_requiredBehavior": { - "description": "Extensions for requiredBehavior", - "$ref": "#/definitions/Element" - }, - "precheckBehavior": { - "description": "Defines whether the action should usually be preselected.", - "enum": [ - "yes", - "no" - ] - }, - "_precheckBehavior": { - "description": "Extensions for precheckBehavior", - "$ref": "#/definitions/Element" - }, - "cardinalityBehavior": { - "description": "Defines whether the action can be selected multiple times.", - "enum": [ - "single", - "multiple" - ] - }, - "_cardinalityBehavior": { - "description": "Extensions for cardinalityBehavior", - "$ref": "#/definitions/Element" - }, - "definitionCanonical": { - "description": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.", - "pattern": "^\\S*$", - "type": "string" - }, - "_definitionCanonical": { - "description": "Extensions for definitionCanonical", - "$ref": "#/definitions/Element" - }, - "definitionUri": { - "description": "A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.", - "pattern": "^\\S*$", - "type": "string" - }, - "_definitionUri": { - "description": "Extensions for definitionUri", - "$ref": "#/definitions/Element" - }, - "transform": { - "description": "A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.", - "$ref": "#/definitions/canonical" - }, - "dynamicValue": { - "description": "Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient\u0027s weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.", - "items": { - "$ref": "#/definitions/PlanDefinition_DynamicValue" - }, - "type": "array" - }, - "action": { - "description": "Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.", - "items": { - "$ref": "#/definitions/PlanDefinition_Action" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "PlanDefinition_Condition": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "kind": { - "description": "The kind of condition.", - "enum": [ - "applicability", - "start", - "stop" - ] - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression that returns true or false, indicating whether the condition is satisfied.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false - }, - "PlanDefinition_RelatedAction": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "actionId": { - "description": "The element id of the related action.", - "$ref": "#/definitions/id" - }, - "_actionId": { - "description": "Extensions for actionId", - "$ref": "#/definitions/Element" - }, - "relationship": { - "description": "The relationship of this action to the related action.", - "enum": [ - "before-start", - "before", - "before-end", - "concurrent-with-start", - "concurrent", - "concurrent-with-end", - "after-start", - "after", - "after-end" - ] - }, - "_relationship": { - "description": "Extensions for relationship", - "$ref": "#/definitions/Element" - }, - "offsetDuration": { - "description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", - "$ref": "#/definitions/Duration" - }, - "offsetRange": { - "description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", - "$ref": "#/definitions/Range" - } - }, - "additionalProperties": false - }, - "PlanDefinition_Participant": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of participant in the action.", - "enum": [ - "patient", - "practitioner", - "related-person", - "device" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "role": { - "description": "The role the participant should play in performing the described action.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "PlanDefinition_DynamicValue": { - "description": "This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "path": { - "description": "The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression specifying the value of the customized element.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false - }, - "Practitioner": { - "description": "A person who is directly or indirectly involved in the provisioning of healthcare.", - "properties": { - "resourceType": { - "description": "This is a Practitioner resource", - "const": "Practitioner" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An identifier that applies to this person in this role.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this practitioner\u0027s record is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "The name(s) associated with the practitioner.", - "items": { - "$ref": "#/definitions/HumanName" - }, - "type": "array" - }, - "telecom": { - "description": "A contact detail for the practitioner, e.g. a telephone number or an email address.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "address": { - "description": "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.", - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array" - }, - "gender": { - "description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "birthDate": { - "description": "The date of birth for the practitioner.", - "$ref": "#/definitions/date" - }, - "_birthDate": { - "description": "Extensions for birthDate", - "$ref": "#/definitions/Element" - }, - "photo": { - "description": "Image of the person.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - }, - "qualification": { - "description": "The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.", - "items": { - "$ref": "#/definitions/Practitioner_Qualification" - }, - "type": "array" - }, - "communication": { - "description": "A language the practitioner can use in patient communication.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Practitioner_Qualification": { - "description": "A person who is directly or indirectly involved in the provisioning of healthcare.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An identifier that applies to this person\u0027s qualification in this role.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "code": { - "description": "Coded representation of the qualification.", - "$ref": "#/definitions/CodeableConcept" - }, - "period": { - "description": "Period during which the qualification is valid.", - "$ref": "#/definitions/Period" - }, - "issuer": { - "description": "Organization that regulates and issues the qualification.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "code" - ] - }, - "PractitionerRole": { - "description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", - "properties": { - "resourceType": { - "description": "This is a PractitionerRole resource", - "const": "PractitionerRole" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business Identifiers that are specific to a role/location.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this practitioner role record is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", - "$ref": "#/definitions/Period" - }, - "practitioner": { - "description": "Practitioner that is able to provide the defined services for the organization.", - "$ref": "#/definitions/Reference" - }, - "organization": { - "description": "The organization where the Practitioner performs the roles associated.", - "$ref": "#/definitions/Reference" - }, - "code": { - "description": "Roles which this practitioner is authorized to perform for the organization.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "Specific specialty of the practitioner.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "location": { - "description": "The location(s) at which this practitioner provides care.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "healthcareService": { - "description": "The list of healthcare services that this worker provides for this role\u0027s Organization/Location(s).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "telecom": { - "description": "Contact details that are specific to the role/location/service.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "availableTime": { - "description": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", - "items": { - "$ref": "#/definitions/PractitionerRole_AvailableTime" - }, - "type": "array" - }, - "notAvailable": { - "description": "The practitioner is not available or performing this role during this period of time due to the provided reason.", - "items": { - "$ref": "#/definitions/PractitionerRole_NotAvailable" - }, - "type": "array" - }, - "availabilityExceptions": { - "description": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.", - "$ref": "#/definitions/string" - }, - "_availabilityExceptions": { - "description": "Extensions for availabilityExceptions", - "$ref": "#/definitions/Element" - }, - "endpoint": { - "description": "Technical endpoints providing access to services operated for the practitioner with this role.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "PractitionerRole_AvailableTime": { - "description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "daysOfWeek": { - "description": "Indicates which days of the week are available between the start and end Times.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_daysOfWeek": { - "description": "Extensions for daysOfWeek", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "allDay": { - "description": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", - "$ref": "#/definitions/boolean" - }, - "_allDay": { - "description": "Extensions for allDay", - "$ref": "#/definitions/Element" - }, - "availableStartTime": { - "description": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", - "$ref": "#/definitions/time" - }, - "_availableStartTime": { - "description": "Extensions for availableStartTime", - "$ref": "#/definitions/Element" - }, - "availableEndTime": { - "description": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", - "$ref": "#/definitions/time" - }, - "_availableEndTime": { - "description": "Extensions for availableEndTime", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "PractitionerRole_NotAvailable": { - "description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "The reason that can be presented to the user as to why this time is not available.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "during": { - "description": "Service is not available (seasonally or for a public holiday) from this date.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "Procedure": { - "description": "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.", - "properties": { - "resourceType": { - "description": "This is a Procedure resource", - "const": "Procedure" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "A reference to a resource that contains details of the request for this procedure.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular procedure is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "Captures the reason for the current state of the procedure.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The person, animal or group on which the procedure was performed.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "performedDateTime": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_performedDateTime": { - "description": "Extensions for performedDateTime", - "$ref": "#/definitions/Element" - }, - "performedPeriod": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "$ref": "#/definitions/Period" - }, - "performedString": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_performedString": { - "description": "Extensions for performedString", - "$ref": "#/definitions/Element" - }, - "performedAge": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "$ref": "#/definitions/Age" - }, - "performedRange": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "$ref": "#/definitions/Range" - }, - "recorder": { - "description": "Individual who recorded the record and takes responsibility for its content.", - "$ref": "#/definitions/Reference" - }, - "asserter": { - "description": "Individual who is making the procedure statement.", - "$ref": "#/definitions/Reference" - }, - "performer": { - "description": "Limited to \"real\" people rather than equipment.", - "items": { - "$ref": "#/definitions/Procedure_Performer" - }, - "type": "array" - }, - "location": { - "description": "The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "The justification of why the procedure was performed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "outcome": { - "description": "The outcome of the procedure - did it resolve the reasons for the procedure being performed?", - "$ref": "#/definitions/CodeableConcept" - }, - "report": { - "description": "This could be a histology result, pathology report, surgical report, etc.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "complication": { - "description": "Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any \u0027post procedure\u0027 issues.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "complicationDetail": { - "description": "Any complications that occurred during the procedure, or in the immediate post-performance period.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "followUp": { - "description": "If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "Any other notes and comments about the procedure.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "focalDevice": { - "description": "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.", - "items": { - "$ref": "#/definitions/Procedure_FocalDevice" - }, - "type": "array" - }, - "usedReference": { - "description": "Identifies medications, devices and any other substance used as part of the procedure.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "usedCode": { - "description": "Identifies coded items that were used as part of the procedure.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "Procedure_Performer": { - "description": "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "function": { - "description": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.", - "$ref": "#/definitions/CodeableConcept" - }, - "actor": { - "description": "The practitioner who was involved in the procedure.", - "$ref": "#/definitions/Reference" - }, - "onBehalfOf": { - "description": "The organization the device or practitioner was acting on behalf of.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "actor" - ] - }, - "Procedure_FocalDevice": { - "description": "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "The kind of change that happened to the device during the procedure.", - "$ref": "#/definitions/CodeableConcept" - }, - "manipulated": { - "description": "The device that was manipulated (changed) during the procedure.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "manipulated" - ] - }, - "Provenance": { - "description": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", - "properties": { - "resourceType": { - "description": "This is a Provenance resource", - "const": "Provenance" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "target": { - "description": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "occurredPeriod": { - "description": "The period during which the activity occurred.", - "$ref": "#/definitions/Period" - }, - "occurredDateTime": { - "description": "The period during which the activity occurred.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurredDateTime": { - "description": "Extensions for occurredDateTime", - "$ref": "#/definitions/Element" - }, - "recorded": { - "description": "The instant of time at which the activity was recorded.", - "$ref": "#/definitions/instant" - }, - "_recorded": { - "description": "Extensions for recorded", - "$ref": "#/definitions/Element" - }, - "policy": { - "description": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_policy": { - "description": "Extensions for policy", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "location": { - "description": "Where the activity occurred, if relevant.", - "$ref": "#/definitions/Reference" - }, - "reason": { - "description": "The reason that the activity was taking place.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "activity": { - "description": "An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.", - "$ref": "#/definitions/CodeableConcept" - }, - "agent": { - "description": "An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.", - "items": { - "$ref": "#/definitions/Provenance_Agent" - }, - "type": "array" - }, - "entity": { - "description": "An entity used in this activity.", - "items": { - "$ref": "#/definitions/Provenance_Entity" - }, - "type": "array" - }, - "signature": { - "description": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.", - "items": { - "$ref": "#/definitions/Signature" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "agent", - "resourceType", - "target" - ] - }, - "Provenance_Agent": { - "description": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The participation the agent had with respect to the activity.", - "$ref": "#/definitions/CodeableConcept" - }, - "role": { - "description": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "who": { - "description": "The individual, device or organization that participated in the event.", - "$ref": "#/definitions/Reference" - }, - "onBehalfOf": { - "description": "The individual, device, or organization for whom the change was made.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "who" - ] - }, - "Provenance_Entity": { - "description": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "role": { - "description": "How the entity was used during the activity.", - "enum": [ - "derivation", - "revision", - "quotation", - "source", - "removal" - ] - }, - "_role": { - "description": "Extensions for role", - "$ref": "#/definitions/Element" - }, - "what": { - "description": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.", - "$ref": "#/definitions/Reference" - }, - "agent": { - "description": "The entity is attributed to an agent to express the agent\u0027s responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.", - "items": { - "$ref": "#/definitions/Provenance_Agent" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "what" - ] - }, - "Questionnaire": { - "description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", - "properties": { - "resourceType": { - "description": "This is a Questionnaire resource", - "const": "Questionnaire" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the questionnaire.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "derivedFrom": { - "description": "The URL of a Questionnaire that this Questionnaire is based on.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "status": { - "description": "The status of this questionnaire. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectType": { - "description": "The types of subjects that can be the subject of responses created for the questionnaire.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_subjectType": { - "description": "Extensions for subjectType", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "date": { - "description": "The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the questionnaire.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the questionnaire from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the questionnaire is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this questionnaire is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the questionnaire content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "code": { - "description": "An identifier for this question or group of questions in a particular terminology such as LOINC.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "item": { - "description": "A particular question, question grouping or display text that is part of the questionnaire.", - "items": { - "$ref": "#/definitions/Questionnaire_Item" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Questionnaire_Item": { - "description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "linkId": { - "description": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.", - "$ref": "#/definitions/string" - }, - "_linkId": { - "description": "Extensions for linkId", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "This element is a URI that refers to an [[[ElementDefinition]]] that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:\n\n* code (ElementDefinition.code) \n* type (ElementDefinition.type) \n* required (ElementDefinition.min) \n* repeats (ElementDefinition.max) \n* maxLength (ElementDefinition.maxLength) \n* answerValueSet (ElementDefinition.binding)\n* options (ElementDefinition.binding).", - "$ref": "#/definitions/uri" - }, - "_definition": { - "description": "Extensions for definition", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "prefix": { - "description": "A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.", - "$ref": "#/definitions/string" - }, - "_prefix": { - "description": "Extensions for prefix", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "The name of a section, the text of a question or text content for a display item.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).", - "enum": [ - "group", - "display", - "boolean", - "decimal", - "integer", - "date", - "dateTime", - "time", - "string", - "text", - "url", - "choice", - "open-choice", - "attachment", - "reference", - "quantity" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "enableWhen": { - "description": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.", - "items": { - "$ref": "#/definitions/Questionnaire_EnableWhen" - }, - "type": "array" - }, - "enableBehavior": { - "description": "Controls how multiple enableWhen values are interpreted - whether all or any must be true.", - "enum": [ - "all", - "any" - ] - }, - "_enableBehavior": { - "description": "Extensions for enableBehavior", - "$ref": "#/definitions/Element" - }, - "required": { - "description": "An indication, if true, that the item must be present in a \"completed\" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.", - "$ref": "#/definitions/boolean" - }, - "_required": { - "description": "Extensions for required", - "$ref": "#/definitions/Element" - }, - "repeats": { - "description": "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.", - "$ref": "#/definitions/boolean" - }, - "_repeats": { - "description": "Extensions for repeats", - "$ref": "#/definitions/Element" - }, - "readOnly": { - "description": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.", - "$ref": "#/definitions/boolean" - }, - "_readOnly": { - "description": "Extensions for readOnly", - "$ref": "#/definitions/Element" - }, - "maxLength": { - "description": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.", - "$ref": "#/definitions/integer" - }, - "_maxLength": { - "description": "Extensions for maxLength", - "$ref": "#/definitions/Element" - }, - "answerValueSet": { - "description": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.", - "$ref": "#/definitions/canonical" - }, - "answerOption": { - "description": "One of the permitted answers for a \"choice\" or \"open-choice\" question.", - "items": { - "$ref": "#/definitions/Questionnaire_AnswerOption" - }, - "type": "array" - }, - "initial": { - "description": "One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.", - "items": { - "$ref": "#/definitions/Questionnaire_Initial" - }, - "type": "array" - }, - "item": { - "description": "Text, questions and other groups to be nested beneath a question or group.", - "items": { - "$ref": "#/definitions/Questionnaire_Item" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Questionnaire_EnableWhen": { - "description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "question": { - "description": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.", - "$ref": "#/definitions/string" - }, - "_question": { - "description": "Extensions for question", - "$ref": "#/definitions/Element" - }, - "operator": { - "description": "Specifies the criteria by which the question is enabled.", - "enum": [ - "exists", - "\u003d", - "!\u003d", - "\u003e", - "\u003c", - "\u003e\u003d", - "\u003c\u003d" - ] - }, - "_operator": { - "description": "Extensions for operator", - "$ref": "#/definitions/Element" - }, - "answerBoolean": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_answerBoolean": { - "description": "Extensions for answerBoolean", - "$ref": "#/definitions/Element" - }, - "answerDecimal": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_answerDecimal": { - "description": "Extensions for answerDecimal", - "$ref": "#/definitions/Element" - }, - "answerInteger": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_answerInteger": { - "description": "Extensions for answerInteger", - "$ref": "#/definitions/Element" - }, - "answerDate": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_answerDate": { - "description": "Extensions for answerDate", - "$ref": "#/definitions/Element" - }, - "answerDateTime": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_answerDateTime": { - "description": "Extensions for answerDateTime", - "$ref": "#/definitions/Element" - }, - "answerTime": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_answerTime": { - "description": "Extensions for answerTime", - "$ref": "#/definitions/Element" - }, - "answerString": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_answerString": { - "description": "Extensions for answerString", - "$ref": "#/definitions/Element" - }, - "answerCoding": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "$ref": "#/definitions/Coding" - }, - "answerQuantity": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "$ref": "#/definitions/Quantity" - }, - "answerReference": { - "description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "Questionnaire_AnswerOption": { - "description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "valueInteger": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueCoding": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "$ref": "#/definitions/Coding" - }, - "valueReference": { - "description": "A potential answer that\u0027s allowed as the answer to this question.", - "$ref": "#/definitions/Reference" - }, - "initialSelected": { - "description": "Indicates whether the answer value is selected when the list of possible answers is initially shown.", - "$ref": "#/definitions/boolean" - }, - "_initialSelected": { - "description": "Extensions for initialSelected", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Questionnaire_Initial": { - "description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "valueBoolean": { - "description": "The actual value to for an initial answer.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The actual value to for an initial answer.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The actual value to for an initial answer.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "The actual value to for an initial answer.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The actual value to for an initial answer.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "The actual value to for an initial answer.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The actual value to for an initial answer.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The actual value to for an initial answer.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueAttachment": { - "description": "The actual value to for an initial answer.", - "$ref": "#/definitions/Attachment" - }, - "valueCoding": { - "description": "The actual value to for an initial answer.", - "$ref": "#/definitions/Coding" - }, - "valueQuantity": { - "description": "The actual value to for an initial answer.", - "$ref": "#/definitions/Quantity" - }, - "valueReference": { - "description": "The actual value to for an initial answer.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "QuestionnaireResponse": { - "description": "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.", - "properties": { - "resourceType": { - "description": "This is a QuestionnaireResponse resource", - "const": "QuestionnaireResponse" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A business identifier assigned to a particular completed (or partially completed) questionnaire.", - "$ref": "#/definitions/Identifier" - }, - "basedOn": { - "description": "The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "questionnaire": { - "description": "The Questionnaire that defines and organizes the questions for which answers are being provided.", - "$ref": "#/definitions/canonical" - }, - "status": { - "description": "The position of the questionnaire response within its overall lifecycle.", - "enum": [ - "in-progress", - "completed", - "amended", - "entered-in-error", - "stopped" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "subject": { - "description": "The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.", - "$ref": "#/definitions/Reference" - }, - "authored": { - "description": "The date and/or time that this set of answers were last changed.", - "$ref": "#/definitions/dateTime" - }, - "_authored": { - "description": "Extensions for authored", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.", - "$ref": "#/definitions/Reference" - }, - "source": { - "description": "The person who answered the questions about the subject.", - "$ref": "#/definitions/Reference" - }, - "item": { - "description": "A group or question item from the original questionnaire for which answers are provided.", - "items": { - "$ref": "#/definitions/QuestionnaireResponse_Item" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "QuestionnaireResponse_Item": { - "description": "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "linkId": { - "description": "The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.", - "$ref": "#/definitions/string" - }, - "_linkId": { - "description": "Extensions for linkId", - "$ref": "#/definitions/Element" - }, - "definition": { - "description": "A reference to an [[[ElementDefinition]]] that provides the details for the item.", - "$ref": "#/definitions/uri" - }, - "_definition": { - "description": "Extensions for definition", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "Text that is displayed above the contents of the group or as the text of the question being answered.", - "$ref": "#/definitions/string" - }, - "_text": { - "description": "Extensions for text", - "$ref": "#/definitions/Element" - }, - "answer": { - "description": "The respondent\u0027s answer(s) to the question.", - "items": { - "$ref": "#/definitions/QuestionnaireResponse_Answer" - }, - "type": "array" - }, - "item": { - "description": "Questions or sub-groups nested beneath a question or group.", - "items": { - "$ref": "#/definitions/QuestionnaireResponse_Item" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "QuestionnaireResponse_Answer": { - "description": "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "valueBoolean": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueAttachment": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "$ref": "#/definitions/Attachment" - }, - "valueCoding": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "$ref": "#/definitions/Coding" - }, - "valueQuantity": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "$ref": "#/definitions/Quantity" - }, - "valueReference": { - "description": "The answer (or one of the answers) provided by the respondent to the question.", - "$ref": "#/definitions/Reference" - }, - "item": { - "description": "Nested groups and/or questions found within this particular answer.", - "items": { - "$ref": "#/definitions/QuestionnaireResponse_Item" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "RelatedPerson": { - "description": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", - "properties": { - "resourceType": { - "description": "This is a RelatedPerson resource", - "const": "RelatedPerson" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for a person within a particular scope.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this related person record is in active use.", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "The patient this person is related to.", - "$ref": "#/definitions/Reference" - }, - "relationship": { - "description": "The nature of the relationship between a patient and the related person.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "name": { - "description": "A name associated with the person.", - "items": { - "$ref": "#/definitions/HumanName" - }, - "type": "array" - }, - "telecom": { - "description": "A contact detail for the person, e.g. a telephone number or an email address.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "gender": { - "description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", - "enum": [ - "male", - "female", - "other", - "unknown" - ] - }, - "_gender": { - "description": "Extensions for gender", - "$ref": "#/definitions/Element" - }, - "birthDate": { - "description": "The date on which the related person was born.", - "$ref": "#/definitions/date" - }, - "_birthDate": { - "description": "Extensions for birthDate", - "$ref": "#/definitions/Element" - }, - "address": { - "description": "Address where the related person can be contacted or visited.", - "items": { - "$ref": "#/definitions/Address" - }, - "type": "array" - }, - "photo": { - "description": "Image of the person.", - "items": { - "$ref": "#/definitions/Attachment" - }, - "type": "array" - }, - "period": { - "description": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.", - "$ref": "#/definitions/Period" - }, - "communication": { - "description": "A language which may be used to communicate with about the patient\u0027s health.", - "items": { - "$ref": "#/definitions/RelatedPerson_Communication" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "patient", - "resourceType" - ] - }, - "RelatedPerson_Communication": { - "description": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "language": { - "description": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.", - "$ref": "#/definitions/CodeableConcept" - }, - "preferred": { - "description": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", - "$ref": "#/definitions/boolean" - }, - "_preferred": { - "description": "Extensions for preferred", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "language" - ] - }, - "RequestGroup": { - "description": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", - "properties": { - "resourceType": { - "description": "This is a RequestGroup resource", - "const": "RequestGroup" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Allows a service to provide a unique, business identifier for the request.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "_instantiatesCanonical": { - "description": "Extensions for instantiatesCanonical", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan, proposal or order that is fulfilled in whole or in part by this request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "replaces": { - "description": "Completed or terminated request(s) whose function is taken by this new request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "groupIdentifier": { - "description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The current state of the request. For request groups, the status reflects the status of all the requests in the group.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "intent": { - "description": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the request should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that identifies what the overall request group is.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The subject for which the request group was created.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "Describes the context of the request group, if any.", - "$ref": "#/definitions/Reference" - }, - "authoredOn": { - "description": "Indicates when the request group was created.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "Provides a reference to the author of the request group.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "Describes the reason for the request group in coded or textual form.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource whose existence justifies this request group.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Provides a mechanism to communicate additional information about the response.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "action": { - "description": "The actions, if any, produced by the evaluation of the artifact.", - "items": { - "$ref": "#/definitions/RequestGroup_Action" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "RequestGroup_Action": { - "description": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "prefix": { - "description": "A user-visible prefix for the action.", - "$ref": "#/definitions/string" - }, - "_prefix": { - "description": "Extensions for prefix", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "The title of the action displayed to a user.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A short description of the action used to provide a summary to display to the user.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "textEquivalent": { - "description": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.", - "$ref": "#/definitions/string" - }, - "_textEquivalent": { - "description": "Extensions for textEquivalent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the action should be addressed with respect to other actions.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "documentation": { - "description": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "condition": { - "description": "An expression that describes applicability criteria, or start/stop conditions for the action.", - "items": { - "$ref": "#/definitions/RequestGroup_Condition" - }, - "type": "array" - }, - "relatedAction": { - "description": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", - "items": { - "$ref": "#/definitions/RequestGroup_RelatedAction" - }, - "type": "array" - }, - "timingDateTime": { - "description": "An optional value describing when the action should be performed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timingDateTime": { - "description": "Extensions for timingDateTime", - "$ref": "#/definitions/Element" - }, - "timingAge": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Age" - }, - "timingPeriod": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Period" - }, - "timingDuration": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Duration" - }, - "timingRange": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Range" - }, - "timingTiming": { - "description": "An optional value describing when the action should be performed.", - "$ref": "#/definitions/Timing" - }, - "participant": { - "description": "The participant that should perform or be responsible for this action.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "type": { - "description": "The type of action to perform (create, update, remove).", - "$ref": "#/definitions/CodeableConcept" - }, - "groupingBehavior": { - "description": "Defines the grouping behavior for the action and its children.", - "$ref": "#/definitions/code" - }, - "_groupingBehavior": { - "description": "Extensions for groupingBehavior", - "$ref": "#/definitions/Element" - }, - "selectionBehavior": { - "description": "Defines the selection behavior for the action and its children.", - "$ref": "#/definitions/code" - }, - "_selectionBehavior": { - "description": "Extensions for selectionBehavior", - "$ref": "#/definitions/Element" - }, - "requiredBehavior": { - "description": "Defines expectations around whether an action is required.", - "$ref": "#/definitions/code" - }, - "_requiredBehavior": { - "description": "Extensions for requiredBehavior", - "$ref": "#/definitions/Element" - }, - "precheckBehavior": { - "description": "Defines whether the action should usually be preselected.", - "$ref": "#/definitions/code" - }, - "_precheckBehavior": { - "description": "Extensions for precheckBehavior", - "$ref": "#/definitions/Element" - }, - "cardinalityBehavior": { - "description": "Defines whether the action can be selected multiple times.", - "$ref": "#/definitions/code" - }, - "_cardinalityBehavior": { - "description": "Extensions for cardinalityBehavior", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "The resource that is the target of the action (e.g. CommunicationRequest).", - "$ref": "#/definitions/Reference" - }, - "action": { - "description": "Sub actions.", - "items": { - "$ref": "#/definitions/RequestGroup_Action" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "RequestGroup_Condition": { - "description": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "kind": { - "description": "The kind of condition.", - "$ref": "#/definitions/code" - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression that returns true or false, indicating whether or not the condition is satisfied.", - "$ref": "#/definitions/Expression" - } - }, - "additionalProperties": false - }, - "RequestGroup_RelatedAction": { - "description": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "actionId": { - "description": "The element id of the action this is related to.", - "$ref": "#/definitions/id" - }, - "_actionId": { - "description": "Extensions for actionId", - "$ref": "#/definitions/Element" - }, - "relationship": { - "description": "The relationship of this action to the related action.", - "$ref": "#/definitions/code" - }, - "_relationship": { - "description": "Extensions for relationship", - "$ref": "#/definitions/Element" - }, - "offsetDuration": { - "description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", - "$ref": "#/definitions/Duration" - }, - "offsetRange": { - "description": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", - "$ref": "#/definitions/Range" - } - }, - "additionalProperties": false - }, - "ResearchDefinition": { - "description": "The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "resourceType": { - "description": "This is a ResearchDefinition resource", - "const": "ResearchDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the research definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "shortTitle": { - "description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.", - "$ref": "#/definitions/string" - }, - "_shortTitle": { - "description": "Extensions for shortTitle", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the ResearchDefinition giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this research definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the research definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the research definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_comment": { - "description": "Extensions for comment", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the research definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this research definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description, from a clinical perspective, of how the ResearchDefinition is used.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the research definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "library": { - "description": "A reference to a Library resource containing the formal logic used by the ResearchDefinition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "population": { - "description": "A reference to a ResearchElementDefinition resource that defines the population for the research.", - "$ref": "#/definitions/Reference" - }, - "exposure": { - "description": "A reference to a ResearchElementDefinition resource that defines the exposure for the research.", - "$ref": "#/definitions/Reference" - }, - "exposureAlternative": { - "description": "A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "A reference to a ResearchElementDefinition resomece that defines the outcome for the research.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType", - "population" - ] - }, - "ResearchElementDefinition": { - "description": "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "resourceType": { - "description": "This is a ResearchElementDefinition resource", - "const": "ResearchElementDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the research element definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "shortTitle": { - "description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.", - "$ref": "#/definitions/string" - }, - "_shortTitle": { - "description": "Extensions for shortTitle", - "$ref": "#/definitions/Element" - }, - "subtitle": { - "description": "An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.", - "$ref": "#/definitions/string" - }, - "_subtitle": { - "description": "Extensions for subtitle", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this research element definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "subjectCodeableConcept": { - "description": "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.", - "$ref": "#/definitions/CodeableConcept" - }, - "subjectReference": { - "description": "The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.", - "$ref": "#/definitions/Reference" - }, - "date": { - "description": "The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the research element definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the research element definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_comment": { - "description": "Extensions for comment", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the research element definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this research element definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "usage": { - "description": "A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.", - "$ref": "#/definitions/string" - }, - "_usage": { - "description": "Extensions for usage", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the research element definition content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "library": { - "description": "A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "type": { - "description": "The type of research element, a population, an exposure, or an outcome.", - "enum": [ - "population", - "exposure", - "outcome" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "variableType": { - "description": "The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).", - "enum": [ - "dichotomous", - "continuous", - "descriptive" - ] - }, - "_variableType": { - "description": "Extensions for variableType", - "$ref": "#/definitions/Element" - }, - "characteristic": { - "description": "A characteristic that defines the members of the research element. Multiple characteristics are applied with \"and\" semantics.", - "items": { - "$ref": "#/definitions/ResearchElementDefinition_Characteristic" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "characteristic", - "resourceType" - ] - }, - "ResearchElementDefinition_Characteristic": { - "description": "The ResearchElementDefinition resource describes a \"PICO\" element that knowledge (evidence, assertion, recommendation) is about.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "definitionCodeableConcept": { - "description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/CodeableConcept" - }, - "definitionCanonical": { - "description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "pattern": "^\\S*$", - "type": "string" - }, - "_definitionCanonical": { - "description": "Extensions for definitionCanonical", - "$ref": "#/definitions/Element" - }, - "definitionExpression": { - "description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/Expression" - }, - "definitionDataRequirement": { - "description": "Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).", - "$ref": "#/definitions/DataRequirement" - }, - "usageContext": { - "description": "Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "exclude": { - "description": "When true, members with this characteristic are excluded from the element.", - "$ref": "#/definitions/boolean" - }, - "_exclude": { - "description": "Extensions for exclude", - "$ref": "#/definitions/Element" - }, - "unitOfMeasure": { - "description": "Specifies the UCUM unit for the outcome.", - "$ref": "#/definitions/CodeableConcept" - }, - "studyEffectiveDescription": { - "description": "A narrative description of the time period the study covers.", - "$ref": "#/definitions/string" - }, - "_studyEffectiveDescription": { - "description": "Extensions for studyEffectiveDescription", - "$ref": "#/definitions/Element" - }, - "studyEffectiveDateTime": { - "description": "Indicates what effective period the study covers.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_studyEffectiveDateTime": { - "description": "Extensions for studyEffectiveDateTime", - "$ref": "#/definitions/Element" - }, - "studyEffectivePeriod": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Period" - }, - "studyEffectiveDuration": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Duration" - }, - "studyEffectiveTiming": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Timing" - }, - "studyEffectiveTimeFromStart": { - "description": "Indicates duration from the study initiation.", - "$ref": "#/definitions/Duration" - }, - "studyEffectiveGroupMeasure": { - "description": "Indicates how elements are aggregated within the study effective period.", - "enum": [ - "mean", - "median", - "mean-of-mean", - "mean-of-median", - "median-of-mean", - "median-of-median" - ] - }, - "_studyEffectiveGroupMeasure": { - "description": "Extensions for studyEffectiveGroupMeasure", - "$ref": "#/definitions/Element" - }, - "participantEffectiveDescription": { - "description": "A narrative description of the time period the study covers.", - "$ref": "#/definitions/string" - }, - "_participantEffectiveDescription": { - "description": "Extensions for participantEffectiveDescription", - "$ref": "#/definitions/Element" - }, - "participantEffectiveDateTime": { - "description": "Indicates what effective period the study covers.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_participantEffectiveDateTime": { - "description": "Extensions for participantEffectiveDateTime", - "$ref": "#/definitions/Element" - }, - "participantEffectivePeriod": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Period" - }, - "participantEffectiveDuration": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Duration" - }, - "participantEffectiveTiming": { - "description": "Indicates what effective period the study covers.", - "$ref": "#/definitions/Timing" - }, - "participantEffectiveTimeFromStart": { - "description": "Indicates duration from the participant\u0027s study entry.", - "$ref": "#/definitions/Duration" - }, - "participantEffectiveGroupMeasure": { - "description": "Indicates how elements are aggregated within the study effective period.", - "enum": [ - "mean", - "median", - "mean-of-mean", - "mean-of-median", - "median-of-mean", - "median-of-median" - ] - }, - "_participantEffectiveGroupMeasure": { - "description": "Extensions for participantEffectiveGroupMeasure", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ResearchStudy": { - "description": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.", - "properties": { - "resourceType": { - "description": "This is a ResearchStudy resource", - "const": "ResearchStudy" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this research study by the sponsor or other systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "title": { - "description": "A short, descriptive user-friendly label for the study.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "protocol": { - "description": "The set of steps expected to be performed as part of the execution of the study.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger research study of which this particular study is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The current state of the study.", - "enum": [ - "active", - "administratively-completed", - "approved", - "closed-to-accrual", - "closed-to-accrual-and-intervention", - "completed", - "disapproved", - "in-review", - "temporarily-closed-to-accrual", - "temporarily-closed-to-accrual-and-intervention", - "withdrawn" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "primaryPurposeType": { - "description": "The type of study based upon the intent of the study\u0027s activities. A classification of the intent of the study.", - "$ref": "#/definitions/CodeableConcept" - }, - "phase": { - "description": "The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", - "$ref": "#/definitions/CodeableConcept" - }, - "category": { - "description": "Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "focus": { - "description": "The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "condition": { - "description": "The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "contact": { - "description": "Contact details to assist a user in learning more about or engaging with the study.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Citations, references and other related documents.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "keyword": { - "description": "Key terms to aid in searching for or filtering the study.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "location": { - "description": "Indicates a country, state or other region where the study is taking place.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "description": { - "description": "A full description of how the study is being conducted.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "enrollment": { - "description": "Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. \" 200 female Europeans between the ages of 20 and 45 with early onset diabetes\".", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "period": { - "description": "Identifies the start date and the expected (or actual, depending on status) end date for the study.", - "$ref": "#/definitions/Period" - }, - "sponsor": { - "description": "An organization that initiates the investigation and is legally responsible for the study.", - "$ref": "#/definitions/Reference" - }, - "principalInvestigator": { - "description": "A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.", - "$ref": "#/definitions/Reference" - }, - "site": { - "description": "A facility in which study activities are conducted.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "reasonStopped": { - "description": "A description and/or code explaining the premature termination of the study.", - "$ref": "#/definitions/CodeableConcept" - }, - "note": { - "description": "Comments made about the study by the performer, subject or other participants.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "arm": { - "description": "Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.", - "items": { - "$ref": "#/definitions/ResearchStudy_Arm" - }, - "type": "array" - }, - "objective": { - "description": "A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.", - "items": { - "$ref": "#/definitions/ResearchStudy_Objective" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ResearchStudy_Arm": { - "description": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Unique, human-readable label for this arm of the study.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "A succinct description of the path through the study that would be followed by a subject adhering to this arm.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ResearchStudy_Objective": { - "description": "A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Unique, human-readable label for this objective of the study.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind of study objective.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "ResearchSubject": { - "description": "A physical entity which is the primary unit of operational and/or administrative interest in a study.", - "properties": { - "resourceType": { - "description": "This is a ResearchSubject resource", - "const": "ResearchSubject" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this research subject for a study.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The current state of the subject.", - "enum": [ - "candidate", - "eligible", - "follow-up", - "ineligible", - "not-registered", - "off-study", - "on-study", - "on-study-intervention", - "on-study-observation", - "pending-on-study", - "potential-candidate", - "screening", - "withdrawn" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "The dates the subject began and ended their participation in the study.", - "$ref": "#/definitions/Period" - }, - "study": { - "description": "Reference to the study the subject is participating in.", - "$ref": "#/definitions/Reference" - }, - "individual": { - "description": "The record of the person or animal who is involved in the study.", - "$ref": "#/definitions/Reference" - }, - "assignedArm": { - "description": "The name of the arm in the study the subject is expected to follow as part of this study.", - "$ref": "#/definitions/string" - }, - "_assignedArm": { - "description": "Extensions for assignedArm", - "$ref": "#/definitions/Element" - }, - "actualArm": { - "description": "The name of the arm in the study the subject actually followed as part of this study.", - "$ref": "#/definitions/string" - }, - "_actualArm": { - "description": "Extensions for actualArm", - "$ref": "#/definitions/Element" - }, - "consent": { - "description": "A record of the patient\u0027s informed agreement to participate in the study.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "study", - "individual", - "resourceType" - ] - }, - "RiskAssessment": { - "description": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.", - "properties": { - "resourceType": { - "description": "This is a RiskAssessment resource", - "const": "RiskAssessment" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifier assigned to the risk assessment.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A reference to the request that is fulfilled by this risk assessment.", - "$ref": "#/definitions/Reference" - }, - "parent": { - "description": "A reference to a resource that this risk assessment is part of, such as a Procedure.", - "$ref": "#/definitions/Reference" - }, - "status": { - "description": "The status of the RiskAssessment, using the same statuses as an Observation.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "method": { - "description": "The algorithm, process or mechanism used to evaluate the risk.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "The type of the risk assessment performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "The patient or group the risk assessment applies to.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The encounter where the assessment was performed.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "The date (and possibly time) the risk assessment was performed.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "The date (and possibly time) the risk assessment was performed.", - "$ref": "#/definitions/Period" - }, - "condition": { - "description": "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.", - "$ref": "#/definitions/Reference" - }, - "performer": { - "description": "The provider or software application that performed the assessment.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "The reason the risk assessment was performed.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Resources supporting the reason the risk assessment was performed.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "basis": { - "description": "Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "prediction": { - "description": "Describes the expected outcome for the subject.", - "items": { - "$ref": "#/definitions/RiskAssessment_Prediction" - }, - "type": "array" - }, - "mitigation": { - "description": "A description of the steps that might be taken to reduce the identified risk(s).", - "$ref": "#/definitions/string" - }, - "_mitigation": { - "description": "Extensions for mitigation", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Additional comments about the risk assessment.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "RiskAssessment_Prediction": { - "description": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "outcome": { - "description": "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).", - "$ref": "#/definitions/CodeableConcept" - }, - "probabilityDecimal": { - "description": "Indicates how likely the outcome is (in the specified timeframe).", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_probabilityDecimal": { - "description": "Extensions for probabilityDecimal", - "$ref": "#/definitions/Element" - }, - "probabilityRange": { - "description": "Indicates how likely the outcome is (in the specified timeframe).", - "$ref": "#/definitions/Range" - }, - "qualitativeRisk": { - "description": "Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).", - "$ref": "#/definitions/CodeableConcept" - }, - "relativeRisk": { - "description": "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 \u003d higher risk than the population, numbers less than 1 \u003d lower risk.).", - "$ref": "#/definitions/decimal" - }, - "_relativeRisk": { - "description": "Extensions for relativeRisk", - "$ref": "#/definitions/Element" - }, - "whenPeriod": { - "description": "Indicates the period of time or age range of the subject to which the specified probability applies.", - "$ref": "#/definitions/Period" - }, - "whenRange": { - "description": "Indicates the period of time or age range of the subject to which the specified probability applies.", - "$ref": "#/definitions/Range" - }, - "rationale": { - "description": "Additional information explaining the basis for the prediction.", - "$ref": "#/definitions/string" - }, - "_rationale": { - "description": "Extensions for rationale", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "RiskEvidenceSynthesis": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "resourceType": { - "description": "This is a RiskEvidenceSynthesis resource", - "const": "RiskEvidenceSynthesis" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this risk evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the risk evidence synthesis.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the risk evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the risk evidence synthesis changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the risk evidence synthesis.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the risk evidence synthesis from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the risk evidence synthesis is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "copyright": { - "description": "A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "approvalDate": { - "description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", - "$ref": "#/definitions/date" - }, - "_approvalDate": { - "description": "Extensions for approvalDate", - "$ref": "#/definitions/Element" - }, - "lastReviewDate": { - "description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", - "$ref": "#/definitions/date" - }, - "_lastReviewDate": { - "description": "Extensions for lastReviewDate", - "$ref": "#/definitions/Element" - }, - "effectivePeriod": { - "description": "The period during which the risk evidence synthesis content was or is planned to be in active use.", - "$ref": "#/definitions/Period" - }, - "topic": { - "description": "Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "author": { - "description": "An individiual or organization primarily involved in the creation and maintenance of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "editor": { - "description": "An individual or organization primarily responsible for internal coherence of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "reviewer": { - "description": "An individual or organization primarily responsible for review of some aspect of the content.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "endorser": { - "description": "An individual or organization responsible for officially endorsing the content for use in some setting.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "relatedArtifact": { - "description": "Related artifacts such as additional documentation, justification, or bibliographic references.", - "items": { - "$ref": "#/definitions/RelatedArtifact" - }, - "type": "array" - }, - "synthesisType": { - "description": "Type of synthesis eg meta-analysis.", - "$ref": "#/definitions/CodeableConcept" - }, - "studyType": { - "description": "Type of study eg randomized trial.", - "$ref": "#/definitions/CodeableConcept" - }, - "population": { - "description": "A reference to a EvidenceVariable resource that defines the population for the research.", - "$ref": "#/definitions/Reference" - }, - "exposure": { - "description": "A reference to a EvidenceVariable resource that defines the exposure for the research.", - "$ref": "#/definitions/Reference" - }, - "outcome": { - "description": "A reference to a EvidenceVariable resomece that defines the outcome for the research.", - "$ref": "#/definitions/Reference" - }, - "sampleSize": { - "description": "A description of the size of the sample involved in the synthesis.", - "$ref": "#/definitions/RiskEvidenceSynthesis_SampleSize" - }, - "riskEstimate": { - "description": "The estimated risk of the outcome.", - "$ref": "#/definitions/RiskEvidenceSynthesis_RiskEstimate" - }, - "certainty": { - "description": "A description of the certainty of the risk estimate.", - "items": { - "$ref": "#/definitions/RiskEvidenceSynthesis_Certainty" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "outcome", - "resourceType", - "population" - ] - }, - "RiskEvidenceSynthesis_SampleSize": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Human-readable summary of sample size.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "numberOfStudies": { - "description": "Number of studies included in this evidence synthesis.", - "$ref": "#/definitions/integer" - }, - "_numberOfStudies": { - "description": "Extensions for numberOfStudies", - "$ref": "#/definitions/Element" - }, - "numberOfParticipants": { - "description": "Number of participants included in this evidence synthesis.", - "$ref": "#/definitions/integer" - }, - "_numberOfParticipants": { - "description": "Extensions for numberOfParticipants", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "RiskEvidenceSynthesis_RiskEstimate": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Human-readable summary of risk estimate.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Examples include proportion and mean.", - "$ref": "#/definitions/CodeableConcept" - }, - "value": { - "description": "The point estimate of the risk estimate.", - "$ref": "#/definitions/decimal" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "unitOfMeasure": { - "description": "Specifies the UCUM unit for the outcome.", - "$ref": "#/definitions/CodeableConcept" - }, - "denominatorCount": { - "description": "The sample size for the group that was measured for this risk estimate.", - "$ref": "#/definitions/integer" - }, - "_denominatorCount": { - "description": "Extensions for denominatorCount", - "$ref": "#/definitions/Element" - }, - "numeratorCount": { - "description": "The number of group members with the outcome of interest.", - "$ref": "#/definitions/integer" - }, - "_numeratorCount": { - "description": "Extensions for numeratorCount", - "$ref": "#/definitions/Element" - }, - "precisionEstimate": { - "description": "A description of the precision of the estimate for the effect.", - "items": { - "$ref": "#/definitions/RiskEvidenceSynthesis_PrecisionEstimate" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "RiskEvidenceSynthesis_PrecisionEstimate": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Examples include confidence interval and interquartile range.", - "$ref": "#/definitions/CodeableConcept" - }, - "level": { - "description": "Use 95 for a 95% confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_level": { - "description": "Extensions for level", - "$ref": "#/definitions/Element" - }, - "from": { - "description": "Lower bound of confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_from": { - "description": "Extensions for from", - "$ref": "#/definitions/Element" - }, - "to": { - "description": "Upper bound of confidence interval.", - "$ref": "#/definitions/decimal" - }, - "_to": { - "description": "Extensions for to", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "RiskEvidenceSynthesis_Certainty": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "rating": { - "description": "A rating of the certainty of the effect estimate.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "certaintySubcomponent": { - "description": "A description of a component of the overall certainty.", - "items": { - "$ref": "#/definitions/RiskEvidenceSynthesis_CertaintySubcomponent" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "RiskEvidenceSynthesis_CertaintySubcomponent": { - "description": "The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Type of subcomponent of certainty rating.", - "$ref": "#/definitions/CodeableConcept" - }, - "rating": { - "description": "A rating of a subcomponent of rating certainty.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "A human-readable string to clarify or explain concepts about the resource.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Schedule": { - "description": "A container for slots of time that may be available for booking appointments.", - "properties": { - "resourceType": { - "description": "This is a Schedule resource", - "const": "Schedule" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "External Ids for this item.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "active": { - "description": "Whether this schedule record is in active use or should not be used (such as was entered in error).", - "$ref": "#/definitions/boolean" - }, - "_active": { - "description": "Extensions for active", - "$ref": "#/definitions/Element" - }, - "serviceCategory": { - "description": "A broad categorization of the service that is to be performed during this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "serviceType": { - "description": "The specific service that is to be performed during this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "actor": { - "description": "Slots that reference this schedule resource provide the availability details to these referenced resource(s).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "planningHorizon": { - "description": "The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization\u0027s planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.", - "$ref": "#/definitions/Period" - }, - "comment": { - "description": "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "actor", - "resourceType" - ] - }, - "SearchParameter": { - "description": "A search parameter that defines a named search item that can be used to search/filter on a resource.", - "properties": { - "resourceType": { - "description": "This is a SearchParameter resource", - "const": "SearchParameter" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "derivedFrom": { - "description": "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.", - "$ref": "#/definitions/canonical" - }, - "status": { - "description": "The status of this search parameter. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the search parameter.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "And how it used.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the search parameter is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this search parameter is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "The code used in the URL or the parameter name in a parameters resource for this search parameter.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "base": { - "description": "The base resource type(s) that this search parameter can be used against.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_base": { - "description": "Extensions for base", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "type": { - "description": "The type of value that a search parameter may contain, and how the content is interpreted.", - "enum": [ - "number", - "date", - "string", - "token", - "reference", - "composite", - "quantity", - "uri", - "special" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "A FHIRPath expression that returns a set of elements for the search parameter.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "xpath": { - "description": "An XPath expression that returns a set of elements for the search parameter.", - "$ref": "#/definitions/string" - }, - "_xpath": { - "description": "Extensions for xpath", - "$ref": "#/definitions/Element" - }, - "xpathUsage": { - "description": "How the search parameter relates to the set of elements returned by evaluating the xpath query.", - "enum": [ - "normal", - "phonetic", - "nearby", - "distance", - "other" - ] - }, - "_xpathUsage": { - "description": "Extensions for xpathUsage", - "$ref": "#/definitions/Element" - }, - "target": { - "description": "Types of resource (if a resource is referenced).", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_target": { - "description": "Extensions for target", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "multipleOr": { - "description": "Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.", - "$ref": "#/definitions/boolean" - }, - "_multipleOr": { - "description": "Extensions for multipleOr", - "$ref": "#/definitions/Element" - }, - "multipleAnd": { - "description": "Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.", - "$ref": "#/definitions/boolean" - }, - "_multipleAnd": { - "description": "Extensions for multipleAnd", - "$ref": "#/definitions/Element" - }, - "comparator": { - "description": "Comparators supported for the search parameter.", - "items": { - "enum": [ - "eq", - "ne", - "gt", - "lt", - "ge", - "le", - "sa", - "eb", - "ap" - ] - }, - "type": "array" - }, - "_comparator": { - "description": "Extensions for comparator", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "modifier": { - "description": "A modifier supported for the search parameter.", - "items": { - "enum": [ - "missing", - "exact", - "contains", - "not", - "text", - "in", - "not-in", - "below", - "above", - "type", - "identifier", - "ofType" - ] - }, - "type": "array" - }, - "_modifier": { - "description": "Extensions for modifier", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "chain": { - "description": "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_chain": { - "description": "Extensions for chain", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "component": { - "description": "Used to define the parts of a composite search parameter.", - "items": { - "$ref": "#/definitions/SearchParameter_Component" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SearchParameter_Component": { - "description": "A search parameter that defines a named search item that can be used to search/filter on a resource.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "definition": { - "description": "The definition of the search parameter that describes this part.", - "$ref": "#/definitions/canonical" - }, - "expression": { - "description": "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "definition" - ] - }, - "ServiceRequest": { - "description": "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.", - "properties": { - "resourceType": { - "description": "This is a ServiceRequest resource", - "const": "ServiceRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "basedOn": { - "description": "Plan/proposal/order fulfilled by this request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "replaces": { - "description": "The request takes the place of the referenced completed or terminated request(s).", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "requisition": { - "description": "A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The status of the order.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "intent": { - "description": "Whether the request is a proposal, plan, an original order or a reflex order.", - "$ref": "#/definitions/code" - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "priority": { - "description": "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "doNotPerform": { - "description": "Set this to true if the record is saying that the service/procedure should NOT be performed.", - "$ref": "#/definitions/boolean" - }, - "_doNotPerform": { - "description": "Extensions for doNotPerform", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.", - "$ref": "#/definitions/CodeableConcept" - }, - "orderDetail": { - "description": "Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "quantityQuantity": { - "description": "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).", - "$ref": "#/definitions/Quantity" - }, - "quantityRatio": { - "description": "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).", - "$ref": "#/definitions/Ratio" - }, - "quantityRange": { - "description": "An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).", - "$ref": "#/definitions/Range" - }, - "subject": { - "description": "On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "An encounter that provides additional information about the healthcare context in which this request is made.", - "$ref": "#/definitions/Reference" - }, - "occurrenceDateTime": { - "description": "The date/time at which the requested service should occur.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "The date/time at which the requested service should occur.", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "The date/time at which the requested service should occur.", - "$ref": "#/definitions/Timing" - }, - "asNeededBoolean": { - "description": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_asNeededBoolean": { - "description": "Extensions for asNeededBoolean", - "$ref": "#/definitions/Element" - }, - "asNeededCodeableConcept": { - "description": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "authoredOn": { - "description": "When the request transitioned to being actionable.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The individual who initiated the request and has responsibility for its activation.", - "$ref": "#/definitions/Reference" - }, - "performerType": { - "description": "Desired type of performer for doing the requested service.", - "$ref": "#/definitions/CodeableConcept" - }, - "performer": { - "description": "The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "locationCode": { - "description": "The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "locationReference": { - "description": "A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "reasonCode": { - "description": "An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "insurance": { - "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "supportingInfo": { - "description": "Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as \"ask at order entry questions (AOEs)\". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "specimen": { - "description": "One or more specimens that the laboratory procedure will use.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "bodySite": { - "description": "Anatomic location where the procedure should be performed. This is the target site.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "Any other notes and comments made about the service request. For example, internal billing notes.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "patientInstruction": { - "description": "Instructions in terms that are understood by the patient or consumer.", - "$ref": "#/definitions/string" - }, - "_patientInstruction": { - "description": "Extensions for patientInstruction", - "$ref": "#/definitions/Element" - }, - "relevantHistory": { - "description": "Key events in the history of the request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "subject", - "resourceType" - ] - }, - "Slot": { - "description": "A slot of time on a schedule that may be available for booking appointments.", - "properties": { - "resourceType": { - "description": "This is a Slot resource", - "const": "Slot" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "External Ids for this item.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "serviceCategory": { - "description": "A broad categorization of the service that is to be performed during this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "serviceType": { - "description": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "specialty": { - "description": "The specialty of a practitioner that would be required to perform the service requested in this appointment.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "appointmentType": { - "description": "The style of appointment or patient that may be booked in the slot (not service type).", - "$ref": "#/definitions/CodeableConcept" - }, - "schedule": { - "description": "The schedule resource that this slot defines an interval of status information.", - "$ref": "#/definitions/Reference" - }, - "status": { - "description": "busy | free | busy-unavailable | busy-tentative | entered-in-error.", - "enum": [ - "busy", - "free", - "busy-unavailable", - "busy-tentative", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "start": { - "description": "Date/Time that the slot is to begin.", - "$ref": "#/definitions/instant" - }, - "_start": { - "description": "Extensions for start", - "$ref": "#/definitions/Element" - }, - "end": { - "description": "Date/Time that the slot is to conclude.", - "$ref": "#/definitions/instant" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "overbooked": { - "description": "This slot has already been overbooked, appointments are unlikely to be accepted for this time.", - "$ref": "#/definitions/boolean" - }, - "_overbooked": { - "description": "Extensions for overbooked", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Comments on the slot to describe any extended information. Such as custom constraints on the slot.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "schedule", - "resourceType" - ] - }, - "Specimen": { - "description": "A sample to be used for analysis.", - "properties": { - "resourceType": { - "description": "This is a Specimen resource", - "const": "Specimen" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Id for specimen.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "accessionIdentifier": { - "description": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.", - "$ref": "#/definitions/Identifier" - }, - "status": { - "description": "The availability of the specimen.", - "enum": [ - "available", - "unavailable", - "unsatisfactory", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind of material that forms the specimen.", - "$ref": "#/definitions/CodeableConcept" - }, - "subject": { - "description": "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.", - "$ref": "#/definitions/Reference" - }, - "receivedTime": { - "description": "Time when specimen was received for processing or testing.", - "$ref": "#/definitions/dateTime" - }, - "_receivedTime": { - "description": "Extensions for receivedTime", - "$ref": "#/definitions/Element" - }, - "parent": { - "description": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "request": { - "description": "Details concerning a service request that required a specimen to be collected.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "collection": { - "description": "Details concerning the specimen collection.", - "$ref": "#/definitions/Specimen_Collection" - }, - "processing": { - "description": "Details concerning processing and processing steps for the specimen.", - "items": { - "$ref": "#/definitions/Specimen_Processing" - }, - "type": "array" - }, - "container": { - "description": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.", - "items": { - "$ref": "#/definitions/Specimen_Container" - }, - "type": "array" - }, - "condition": { - "description": "A mode or state of being that describes the nature of the specimen.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "note": { - "description": "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Specimen_Collection": { - "description": "A sample to be used for analysis.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "collector": { - "description": "Person who collected the specimen.", - "$ref": "#/definitions/Reference" - }, - "collectedDateTime": { - "description": "Time when specimen was collected from subject - the physiologically relevant time.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_collectedDateTime": { - "description": "Extensions for collectedDateTime", - "$ref": "#/definitions/Element" - }, - "collectedPeriod": { - "description": "Time when specimen was collected from subject - the physiologically relevant time.", - "$ref": "#/definitions/Period" - }, - "duration": { - "description": "The span of time over which the collection of a specimen occurred.", - "$ref": "#/definitions/Duration" - }, - "quantity": { - "description": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.", - "$ref": "#/definitions/Quantity" - }, - "method": { - "description": "A coded value specifying the technique that is used to perform the procedure.", - "$ref": "#/definitions/CodeableConcept" - }, - "bodySite": { - "description": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", - "$ref": "#/definitions/CodeableConcept" - }, - "fastingStatusCodeableConcept": { - "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.", - "$ref": "#/definitions/CodeableConcept" - }, - "fastingStatusDuration": { - "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.", - "$ref": "#/definitions/Duration" - } - }, - "additionalProperties": false - }, - "Specimen_Processing": { - "description": "A sample to be used for analysis.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Textual description of procedure.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "procedure": { - "description": "A coded value specifying the procedure used to process the specimen.", - "$ref": "#/definitions/CodeableConcept" - }, - "additive": { - "description": "Material used in the processing step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "timeDateTime": { - "description": "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_timeDateTime": { - "description": "Extensions for timeDateTime", - "$ref": "#/definitions/Element" - }, - "timePeriod": { - "description": "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.", - "$ref": "#/definitions/Period" - } - }, - "additionalProperties": false - }, - "Specimen_Container": { - "description": "A sample to be used for analysis.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Id for container. There may be multiple; a manufacturer\u0027s bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "description": { - "description": "Textual description of the container.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The type of container associated with the specimen (e.g. slide, aliquot, etc.).", - "$ref": "#/definitions/CodeableConcept" - }, - "capacity": { - "description": "The capacity (volume or other measure) the container may contain.", - "$ref": "#/definitions/Quantity" - }, - "specimenQuantity": { - "description": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.", - "$ref": "#/definitions/Quantity" - }, - "additiveCodeableConcept": { - "description": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", - "$ref": "#/definitions/CodeableConcept" - }, - "additiveReference": { - "description": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "SpecimenDefinition": { - "description": "A kind of specimen with associated set of requirements.", - "properties": { - "resourceType": { - "description": "This is a SpecimenDefinition resource", - "const": "SpecimenDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A business identifier associated with the kind of specimen.", - "$ref": "#/definitions/Identifier" - }, - "typeCollected": { - "description": "The kind of material to be collected.", - "$ref": "#/definitions/CodeableConcept" - }, - "patientPreparation": { - "description": "Preparation of the patient for specimen collection.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "timeAspect": { - "description": "Time aspect of specimen collection (duration or offset).", - "$ref": "#/definitions/string" - }, - "_timeAspect": { - "description": "Extensions for timeAspect", - "$ref": "#/definitions/Element" - }, - "collection": { - "description": "The action to be performed for collecting the specimen.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "typeTested": { - "description": "Specimen conditioned in a container as expected by the testing laboratory.", - "items": { - "$ref": "#/definitions/SpecimenDefinition_TypeTested" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SpecimenDefinition_TypeTested": { - "description": "A kind of specimen with associated set of requirements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "isDerived": { - "description": "Primary of secondary specimen.", - "$ref": "#/definitions/boolean" - }, - "_isDerived": { - "description": "Extensions for isDerived", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "The kind of specimen conditioned for testing expected by lab.", - "$ref": "#/definitions/CodeableConcept" - }, - "preference": { - "description": "The preference for this type of conditioned specimen.", - "enum": [ - "preferred", - "alternate" - ] - }, - "_preference": { - "description": "Extensions for preference", - "$ref": "#/definitions/Element" - }, - "container": { - "description": "The specimen\u0027s container.", - "$ref": "#/definitions/SpecimenDefinition_Container" - }, - "requirement": { - "description": "Requirements for delivery and special handling of this kind of conditioned specimen.", - "$ref": "#/definitions/string" - }, - "_requirement": { - "description": "Extensions for requirement", - "$ref": "#/definitions/Element" - }, - "retentionTime": { - "description": "The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.", - "$ref": "#/definitions/Duration" - }, - "rejectionCriterion": { - "description": "Criterion for rejection of the specimen in its container by the laboratory.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "handling": { - "description": "Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.", - "items": { - "$ref": "#/definitions/SpecimenDefinition_Handling" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SpecimenDefinition_Container": { - "description": "A kind of specimen with associated set of requirements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "material": { - "description": "The type of material of the container.", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "The type of container used to contain this kind of specimen.", - "$ref": "#/definitions/CodeableConcept" - }, - "cap": { - "description": "Color of container cap.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "The textual description of the kind of container.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "capacity": { - "description": "The capacity (volume or other measure) of this kind of container.", - "$ref": "#/definitions/Quantity" - }, - "minimumVolumeQuantity": { - "description": "The minimum volume to be conditioned in the container.", - "$ref": "#/definitions/Quantity" - }, - "minimumVolumeString": { - "description": "The minimum volume to be conditioned in the container.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_minimumVolumeString": { - "description": "Extensions for minimumVolumeString", - "$ref": "#/definitions/Element" - }, - "additive": { - "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", - "items": { - "$ref": "#/definitions/SpecimenDefinition_Additive" - }, - "type": "array" - }, - "preparation": { - "description": "Special processing that should be applied to the container for this kind of specimen.", - "$ref": "#/definitions/string" - }, - "_preparation": { - "description": "Extensions for preparation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SpecimenDefinition_Additive": { - "description": "A kind of specimen with associated set of requirements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "additiveCodeableConcept": { - "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", - "$ref": "#/definitions/CodeableConcept" - }, - "additiveReference": { - "description": "Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "SpecimenDefinition_Handling": { - "description": "A kind of specimen with associated set of requirements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "temperatureQualifier": { - "description": "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.", - "$ref": "#/definitions/CodeableConcept" - }, - "temperatureRange": { - "description": "The temperature interval for this set of handling instructions.", - "$ref": "#/definitions/Range" - }, - "maxDuration": { - "description": "The maximum time interval of preservation of the specimen with these conditions.", - "$ref": "#/definitions/Duration" - }, - "instruction": { - "description": "Additional textual instructions for the preservation or transport of the specimen. For instance, \u0027Protect from light exposure\u0027.", - "$ref": "#/definitions/string" - }, - "_instruction": { - "description": "Extensions for instruction", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureDefinition": { - "description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "properties": { - "resourceType": { - "description": "This is a StructureDefinition resource", - "const": "StructureDefinition" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the structure definition.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this structure definition. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the structure definition.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the structure definition from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the structure definition is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this structure definition is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "keyword": { - "description": "A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.", - "items": { - "$ref": "#/definitions/Coding" - }, - "type": "array" - }, - "fhirVersion": { - "description": "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.", - "enum": [ - "0.01", - "0.05", - "0.06", - "0.11", - "0.0.80", - "0.0.81", - "0.0.82", - "0.4.0", - "0.5.0", - "1.0.0", - "1.0.1", - "1.0.2", - "1.1.0", - "1.4.0", - "1.6.0", - "1.8.0", - "3.0.0", - "3.0.1", - "3.3.0", - "3.5.0", - "4.0.0", - "4.0.1" - ] - }, - "_fhirVersion": { - "description": "Extensions for fhirVersion", - "$ref": "#/definitions/Element" - }, - "mapping": { - "description": "An external specification that the content is mapped to.", - "items": { - "$ref": "#/definitions/StructureDefinition_Mapping" - }, - "type": "array" - }, - "kind": { - "description": "Defines the kind of structure that this definition is describing.", - "enum": [ - "primitive-type", - "complex-type", - "resource", - "logical" - ] - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "abstract": { - "description": "Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.", - "$ref": "#/definitions/boolean" - }, - "_abstract": { - "description": "Extensions for abstract", - "$ref": "#/definitions/Element" - }, - "context": { - "description": "Identifies the types of resource or data type elements to which the extension can be applied.", - "items": { - "$ref": "#/definitions/StructureDefinition_Context" - }, - "type": "array" - }, - "contextInvariant": { - "description": "A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_contextInvariant": { - "description": "Extensions for contextInvariant", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "type": { - "description": "The type this structure describes. If the derivation kind is \u0027specialization\u0027 then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.", - "$ref": "#/definitions/uri" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "baseDefinition": { - "description": "An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.", - "$ref": "#/definitions/canonical" - }, - "derivation": { - "description": "How the type relates to the baseDefinition.", - "enum": [ - "specialization", - "constraint" - ] - }, - "_derivation": { - "description": "Extensions for derivation", - "$ref": "#/definitions/Element" - }, - "snapshot": { - "description": "A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.", - "$ref": "#/definitions/StructureDefinition_Snapshot" - }, - "differential": { - "description": "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.", - "$ref": "#/definitions/StructureDefinition_Differential" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "StructureDefinition_Mapping": { - "description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identity": { - "description": "An Internal id that is used to identify this mapping set when specific mappings are made.", - "$ref": "#/definitions/id" - }, - "_identity": { - "description": "Extensions for identity", - "$ref": "#/definitions/Element" - }, - "uri": { - "description": "An absolute URI that identifies the specification that this mapping is expressed to.", - "$ref": "#/definitions/uri" - }, - "_uri": { - "description": "Extensions for uri", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A name for the specification that is being mapped to.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureDefinition_Context": { - "description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Defines how to interpret the expression that defines what the context of the extension is.", - "enum": [ - "fhirpath", - "element", - "extension" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "An expression that defines where an extension can be used in resources.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureDefinition_Snapshot": { - "description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "element": { - "description": "Captures constraints on each element within the resource.", - "items": { - "$ref": "#/definitions/ElementDefinition" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "element" - ] - }, - "StructureDefinition_Differential": { - "description": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "element": { - "description": "Captures constraints on each element within the resource.", - "items": { - "$ref": "#/definitions/ElementDefinition" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "element" - ] - }, - "StructureMap": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "resourceType": { - "description": "This is a StructureMap resource", - "const": "StructureMap" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the structure map.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this structure map. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the structure map.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the structure map from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the structure map is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this structure map is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "structure": { - "description": "A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.", - "items": { - "$ref": "#/definitions/StructureMap_Structure" - }, - "type": "array" - }, - "import": { - "description": "Other maps used by this map (canonical URLs).", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - }, - "group": { - "description": "Organizes the mapping into manageable chunks for human review/ease of maintenance.", - "items": { - "$ref": "#/definitions/StructureMap_Group" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType", - "group" - ] - }, - "StructureMap_Structure": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "The canonical reference to the structure.", - "$ref": "#/definitions/canonical" - }, - "mode": { - "description": "How the referenced structure is used in this mapping.", - "enum": [ - "source", - "queried", - "target", - "produced" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "alias": { - "description": "The name used for this type in the map.", - "$ref": "#/definitions/string" - }, - "_alias": { - "description": "Extensions for alias", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Documentation that describes how the structure is used in the mapping.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "url" - ] - }, - "StructureMap_Group": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "A unique name for the group for the convenience of human readers.", - "$ref": "#/definitions/id" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "extends": { - "description": "Another group that this group adds rules to.", - "$ref": "#/definitions/id" - }, - "_extends": { - "description": "Extensions for extends", - "$ref": "#/definitions/Element" - }, - "typeMode": { - "description": "If this is the default rule set to apply for the source type or this combination of types.", - "enum": [ - "none", - "types", - "type-and-types" - ] - }, - "_typeMode": { - "description": "Extensions for typeMode", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Additional supporting documentation that explains the purpose of the group and the types of mappings within it.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - }, - "input": { - "description": "A name assigned to an instance of data. The instance must be provided when the mapping is invoked.", - "items": { - "$ref": "#/definitions/StructureMap_Input" - }, - "type": "array" - }, - "rule": { - "description": "Transform Rule from source to target.", - "items": { - "$ref": "#/definitions/StructureMap_Rule" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "input", - "rule" - ] - }, - "StructureMap_Input": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name for this instance of data.", - "$ref": "#/definitions/id" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Type for this instance of data.", - "$ref": "#/definitions/string" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "mode": { - "description": "Mode for this instance of data.", - "enum": [ - "source", - "target" - ] - }, - "_mode": { - "description": "Extensions for mode", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Documentation for this instance of data.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureMap_Rule": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name of the rule for internal references.", - "$ref": "#/definitions/id" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "Source inputs to the mapping.", - "items": { - "$ref": "#/definitions/StructureMap_Source" - }, - "type": "array" - }, - "target": { - "description": "Content to create because of this mapping rule.", - "items": { - "$ref": "#/definitions/StructureMap_Target" - }, - "type": "array" - }, - "rule": { - "description": "Rules contained in this rule.", - "items": { - "$ref": "#/definitions/StructureMap_Rule" - }, - "type": "array" - }, - "dependent": { - "description": "Which other rules to apply in the context of this rule.", - "items": { - "$ref": "#/definitions/StructureMap_Dependent" - }, - "type": "array" - }, - "documentation": { - "description": "Documentation for this instance of data.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false, - "required": [ - "source" - ] - }, - "StructureMap_Source": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "context": { - "description": "Type or variable this rule applies to.", - "$ref": "#/definitions/id" - }, - "_context": { - "description": "Extensions for context", - "$ref": "#/definitions/Element" - }, - "min": { - "description": "Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.", - "$ref": "#/definitions/integer" - }, - "_min": { - "description": "Extensions for min", - "$ref": "#/definitions/Element" - }, - "max": { - "description": "Specified maximum cardinality for the element - a number or a \"*\". This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it\u0027s the default value).", - "$ref": "#/definitions/string" - }, - "_max": { - "description": "Extensions for max", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.", - "$ref": "#/definitions/string" - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "defaultValueBase64Binary": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_defaultValueBase64Binary": { - "description": "Extensions for defaultValueBase64Binary", - "$ref": "#/definitions/Element" - }, - "defaultValueBoolean": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_defaultValueBoolean": { - "description": "Extensions for defaultValueBoolean", - "$ref": "#/definitions/Element" - }, - "defaultValueCanonical": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueCanonical": { - "description": "Extensions for defaultValueCanonical", - "$ref": "#/definitions/Element" - }, - "defaultValueCode": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_defaultValueCode": { - "description": "Extensions for defaultValueCode", - "$ref": "#/definitions/Element" - }, - "defaultValueDate": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_defaultValueDate": { - "description": "Extensions for defaultValueDate", - "$ref": "#/definitions/Element" - }, - "defaultValueDateTime": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_defaultValueDateTime": { - "description": "Extensions for defaultValueDateTime", - "$ref": "#/definitions/Element" - }, - "defaultValueDecimal": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_defaultValueDecimal": { - "description": "Extensions for defaultValueDecimal", - "$ref": "#/definitions/Element" - }, - "defaultValueId": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_defaultValueId": { - "description": "Extensions for defaultValueId", - "$ref": "#/definitions/Element" - }, - "defaultValueInstant": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_defaultValueInstant": { - "description": "Extensions for defaultValueInstant", - "$ref": "#/definitions/Element" - }, - "defaultValueInteger": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_defaultValueInteger": { - "description": "Extensions for defaultValueInteger", - "$ref": "#/definitions/Element" - }, - "defaultValueMarkdown": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_defaultValueMarkdown": { - "description": "Extensions for defaultValueMarkdown", - "$ref": "#/definitions/Element" - }, - "defaultValueOid": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_defaultValueOid": { - "description": "Extensions for defaultValueOid", - "$ref": "#/definitions/Element" - }, - "defaultValuePositiveInt": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_defaultValuePositiveInt": { - "description": "Extensions for defaultValuePositiveInt", - "$ref": "#/definitions/Element" - }, - "defaultValueString": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_defaultValueString": { - "description": "Extensions for defaultValueString", - "$ref": "#/definitions/Element" - }, - "defaultValueTime": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_defaultValueTime": { - "description": "Extensions for defaultValueTime", - "$ref": "#/definitions/Element" - }, - "defaultValueUnsignedInt": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_defaultValueUnsignedInt": { - "description": "Extensions for defaultValueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "defaultValueUri": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueUri": { - "description": "Extensions for defaultValueUri", - "$ref": "#/definitions/Element" - }, - "defaultValueUrl": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^\\S*$", - "type": "string" - }, - "_defaultValueUrl": { - "description": "Extensions for defaultValueUrl", - "$ref": "#/definitions/Element" - }, - "defaultValueUuid": { - "description": "A value to use if there is no existing value in the source object.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_defaultValueUuid": { - "description": "Extensions for defaultValueUuid", - "$ref": "#/definitions/Element" - }, - "defaultValueAddress": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Address" - }, - "defaultValueAge": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Age" - }, - "defaultValueAnnotation": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Annotation" - }, - "defaultValueAttachment": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Attachment" - }, - "defaultValueCodeableConcept": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/CodeableConcept" - }, - "defaultValueCoding": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Coding" - }, - "defaultValueContactPoint": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/ContactPoint" - }, - "defaultValueCount": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Count" - }, - "defaultValueDistance": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Distance" - }, - "defaultValueDuration": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Duration" - }, - "defaultValueHumanName": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/HumanName" - }, - "defaultValueIdentifier": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Identifier" - }, - "defaultValueMoney": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Money" - }, - "defaultValuePeriod": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Period" - }, - "defaultValueQuantity": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Quantity" - }, - "defaultValueRange": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Range" - }, - "defaultValueRatio": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Ratio" - }, - "defaultValueReference": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Reference" - }, - "defaultValueSampledData": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/SampledData" - }, - "defaultValueSignature": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Signature" - }, - "defaultValueTiming": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Timing" - }, - "defaultValueContactDetail": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/ContactDetail" - }, - "defaultValueContributor": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Contributor" - }, - "defaultValueDataRequirement": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/DataRequirement" - }, - "defaultValueExpression": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Expression" - }, - "defaultValueParameterDefinition": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/ParameterDefinition" - }, - "defaultValueRelatedArtifact": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/RelatedArtifact" - }, - "defaultValueTriggerDefinition": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/TriggerDefinition" - }, - "defaultValueUsageContext": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/UsageContext" - }, - "defaultValueDosage": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Dosage" - }, - "defaultValueMeta": { - "description": "A value to use if there is no existing value in the source object.", - "$ref": "#/definitions/Meta" - }, - "element": { - "description": "Optional field for this source.", - "$ref": "#/definitions/string" - }, - "_element": { - "description": "Extensions for element", - "$ref": "#/definitions/Element" - }, - "listMode": { - "description": "How to handle the list mode for this element.", - "enum": [ - "first", - "not_first", - "last", - "not_last", - "only_one" - ] - }, - "_listMode": { - "description": "Extensions for listMode", - "$ref": "#/definitions/Element" - }, - "variable": { - "description": "Named context for field, if a field is specified.", - "$ref": "#/definitions/id" - }, - "_variable": { - "description": "Extensions for variable", - "$ref": "#/definitions/Element" - }, - "condition": { - "description": "FHIRPath expression - must be true or the rule does not apply.", - "$ref": "#/definitions/string" - }, - "_condition": { - "description": "Extensions for condition", - "$ref": "#/definitions/Element" - }, - "check": { - "description": "FHIRPath expression - must be true or the mapping engine throws an error instead of completing.", - "$ref": "#/definitions/string" - }, - "_check": { - "description": "Extensions for check", - "$ref": "#/definitions/Element" - }, - "logMessage": { - "description": "A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.", - "$ref": "#/definitions/string" - }, - "_logMessage": { - "description": "Extensions for logMessage", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureMap_Target": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "context": { - "description": "Type or variable this rule applies to.", - "$ref": "#/definitions/id" - }, - "_context": { - "description": "Extensions for context", - "$ref": "#/definitions/Element" - }, - "contextType": { - "description": "How to interpret the context.", - "enum": [ - "type", - "variable" - ] - }, - "_contextType": { - "description": "Extensions for contextType", - "$ref": "#/definitions/Element" - }, - "element": { - "description": "Field to create in the context.", - "$ref": "#/definitions/string" - }, - "_element": { - "description": "Extensions for element", - "$ref": "#/definitions/Element" - }, - "variable": { - "description": "Named context for field, if desired, and a field is specified.", - "$ref": "#/definitions/id" - }, - "_variable": { - "description": "Extensions for variable", - "$ref": "#/definitions/Element" - }, - "listMode": { - "description": "If field is a list, how to manage the list.", - "items": { - "enum": [ - "first", - "share", - "last", - "collate" - ] - }, - "type": "array" - }, - "_listMode": { - "description": "Extensions for listMode", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "listRuleId": { - "description": "Internal rule reference for shared list items.", - "$ref": "#/definitions/id" - }, - "_listRuleId": { - "description": "Extensions for listRuleId", - "$ref": "#/definitions/Element" - }, - "transform": { - "description": "How the data is copied / created.", - "enum": [ - "create", - "copy", - "truncate", - "escape", - "cast", - "append", - "translate", - "reference", - "dateOp", - "uuid", - "pointer", - "evaluate", - "cc", - "c", - "qty", - "id", - "cp" - ] - }, - "_transform": { - "description": "Extensions for transform", - "$ref": "#/definitions/Element" - }, - "parameter": { - "description": "Parameters to the transform.", - "items": { - "$ref": "#/definitions/StructureMap_Parameter" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "StructureMap_Parameter": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "valueId": { - "description": "Parameter value - variable or literal.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "Parameter value - variable or literal.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "Parameter value - variable or literal.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "Parameter value - variable or literal.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "Parameter value - variable or literal.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "StructureMap_Dependent": { - "description": "A Map of relationships between 2 structures that can be used to transform data.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name of a rule or group to apply.", - "$ref": "#/definitions/id" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "variable": { - "description": "Variable to pass to the rule or group.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_variable": { - "description": "Extensions for variable", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Subscription": { - "description": "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.", - "properties": { - "resourceType": { - "description": "This is a Subscription resource", - "const": "Subscription" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "status": { - "description": "The status of the subscription, which marks the server state for managing the subscription.", - "enum": [ - "requested", - "active", - "error", - "off" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.", - "items": { - "$ref": "#/definitions/ContactPoint" - }, - "type": "array" - }, - "end": { - "description": "The time for the server to turn the subscription off.", - "$ref": "#/definitions/instant" - }, - "_end": { - "description": "Extensions for end", - "$ref": "#/definitions/Element" - }, - "reason": { - "description": "A description of why this subscription is defined.", - "$ref": "#/definitions/string" - }, - "_reason": { - "description": "Extensions for reason", - "$ref": "#/definitions/Element" - }, - "criteria": { - "description": "The rules that the server should use to determine when to generate notifications for this subscription.", - "$ref": "#/definitions/string" - }, - "_criteria": { - "description": "Extensions for criteria", - "$ref": "#/definitions/Element" - }, - "error": { - "description": "A record of the last error that occurred when the server processed a notification.", - "$ref": "#/definitions/string" - }, - "_error": { - "description": "Extensions for error", - "$ref": "#/definitions/Element" - }, - "channel": { - "description": "Details where to send notifications when resources are received that meet the criteria.", - "$ref": "#/definitions/Subscription_Channel" - } - }, - "additionalProperties": false, - "required": [ - "channel", - "resourceType" - ] - }, - "Subscription_Channel": { - "description": "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of channel to send notifications on.", - "enum": [ - "rest-hook", - "websocket", - "email", - "sms", - "message" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "endpoint": { - "description": "The url that describes the actual end-point to send messages to.", - "$ref": "#/definitions/url" - }, - "_endpoint": { - "description": "Extensions for endpoint", - "$ref": "#/definitions/Element" - }, - "payload": { - "description": "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type \"text/plain\" may also be used for Email and SMS subscriptions.", - "$ref": "#/definitions/code" - }, - "_payload": { - "description": "Extensions for payload", - "$ref": "#/definitions/Element" - }, - "header": { - "description": "Additional headers / information to send as part of the notification.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_header": { - "description": "Extensions for header", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Substance": { - "description": "A homogeneous material with a definite composition.", - "properties": { - "resourceType": { - "description": "This is a Substance resource", - "const": "Substance" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Unique identifier for the substance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "A code to indicate if the substance is actively used.", - "enum": [ - "active", - "inactive", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "code": { - "description": "A code (or set of codes) that identify this substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "A description of the substance - its appearance, handling requirements, and other usage notes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "instance": { - "description": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.", - "items": { - "$ref": "#/definitions/Substance_Instance" - }, - "type": "array" - }, - "ingredient": { - "description": "A substance can be composed of other substances.", - "items": { - "$ref": "#/definitions/Substance_Ingredient" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "code", - "resourceType" - ] - }, - "Substance_Instance": { - "description": "A homogeneous material with a definite composition.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier associated with the package/container (usually a label affixed directly).", - "$ref": "#/definitions/Identifier" - }, - "expiry": { - "description": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.", - "$ref": "#/definitions/dateTime" - }, - "_expiry": { - "description": "Extensions for expiry", - "$ref": "#/definitions/Element" - }, - "quantity": { - "description": "The amount of the substance.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "Substance_Ingredient": { - "description": "A homogeneous material with a definite composition.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "quantity": { - "description": "The amount of the ingredient in the substance - a concentration ratio.", - "$ref": "#/definitions/Ratio" - }, - "substanceCodeableConcept": { - "description": "Another substance that is a component of this substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "substanceReference": { - "description": "Another substance that is a component of this substance.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "SubstanceNucleicAcid": { - "description": "Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.", - "properties": { - "resourceType": { - "description": "This is a SubstanceNucleicAcid resource", - "const": "SubstanceNucleicAcid" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequenceType": { - "description": "The type of the sequence shall be specified based on a controlled vocabulary.", - "$ref": "#/definitions/CodeableConcept" - }, - "numberOfSubunits": { - "description": "The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.", - "$ref": "#/definitions/integer" - }, - "_numberOfSubunits": { - "description": "Extensions for numberOfSubunits", - "$ref": "#/definitions/Element" - }, - "areaOfHybridisation": { - "description": "The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.", - "$ref": "#/definitions/string" - }, - "_areaOfHybridisation": { - "description": "Extensions for areaOfHybridisation", - "$ref": "#/definitions/Element" - }, - "oligoNucleotideType": { - "description": "(TBC).", - "$ref": "#/definitions/CodeableConcept" - }, - "subunit": { - "description": "Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.", - "items": { - "$ref": "#/definitions/SubstanceNucleicAcid_Subunit" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstanceNucleicAcid_Subunit": { - "description": "Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subunit": { - "description": "Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.", - "$ref": "#/definitions/integer" - }, - "_subunit": { - "description": "Extensions for subunit", - "$ref": "#/definitions/Element" - }, - "sequence": { - "description": "Actual nucleotide sequence notation from 5\u0027 to 3\u0027 end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured.", - "$ref": "#/definitions/string" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "length": { - "description": "The length of the sequence shall be captured.", - "$ref": "#/definitions/integer" - }, - "_length": { - "description": "Extensions for length", - "$ref": "#/definitions/Element" - }, - "sequenceAttachment": { - "description": "(TBC).", - "$ref": "#/definitions/Attachment" - }, - "fivePrime": { - "description": "The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5\u0027 to the 3\u0027 end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant.", - "$ref": "#/definitions/CodeableConcept" - }, - "threePrime": { - "description": "The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5\u0027 to the 3\u0027 end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant.", - "$ref": "#/definitions/CodeableConcept" - }, - "linkage": { - "description": "The linkages between sugar residues will also be captured.", - "items": { - "$ref": "#/definitions/SubstanceNucleicAcid_Linkage" - }, - "type": "array" - }, - "sugar": { - "description": "5.3.6.8.1 Sugar ID (Mandatory).", - "items": { - "$ref": "#/definitions/SubstanceNucleicAcid_Sugar" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceNucleicAcid_Linkage": { - "description": "Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "connectivity": { - "description": "The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified.", - "$ref": "#/definitions/string" - }, - "_connectivity": { - "description": "Extensions for connectivity", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "Each linkage will be registered as a fragment and have an ID.", - "$ref": "#/definitions/Identifier" - }, - "name": { - "description": "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "residueSite": { - "description": "Residues shall be captured as described in 5.3.6.8.3.", - "$ref": "#/definitions/string" - }, - "_residueSite": { - "description": "Extensions for residueSite", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceNucleicAcid_Sugar": { - "description": "Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The Substance ID of the sugar or sugar-like component that make up the nucleotide.", - "$ref": "#/definitions/Identifier" - }, - "name": { - "description": "The name of the sugar or sugar-like component that make up the nucleotide.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "residueSite": { - "description": "The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above.", - "$ref": "#/definitions/string" - }, - "_residueSite": { - "description": "Extensions for residueSite", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstancePolymer": { - "description": "Todo.", - "properties": { - "resourceType": { - "description": "This is a SubstancePolymer resource", - "const": "SubstancePolymer" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "class": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "geometry": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "copolymerConnectivity": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "modification": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_modification": { - "description": "Extensions for modification", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "monomerSet": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_MonomerSet" - }, - "type": "array" - }, - "repeat": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_Repeat" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstancePolymer_MonomerSet": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "ratioType": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "startingMaterial": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_StartingMaterial" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstancePolymer_StartingMaterial": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "material": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "isDefining": { - "description": "Todo.", - "$ref": "#/definitions/boolean" - }, - "_isDefining": { - "description": "Extensions for isDefining", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "Todo.", - "$ref": "#/definitions/SubstanceAmount" - } - }, - "additionalProperties": false - }, - "SubstancePolymer_Repeat": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "numberOfUnits": { - "description": "Todo.", - "$ref": "#/definitions/integer" - }, - "_numberOfUnits": { - "description": "Extensions for numberOfUnits", - "$ref": "#/definitions/Element" - }, - "averageMolecularFormula": { - "description": "Todo.", - "$ref": "#/definitions/string" - }, - "_averageMolecularFormula": { - "description": "Extensions for averageMolecularFormula", - "$ref": "#/definitions/Element" - }, - "repeatUnitAmountType": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "repeatUnit": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_RepeatUnit" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstancePolymer_RepeatUnit": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "orientationOfPolymerisation": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "repeatUnit": { - "description": "Todo.", - "$ref": "#/definitions/string" - }, - "_repeatUnit": { - "description": "Extensions for repeatUnit", - "$ref": "#/definitions/Element" - }, - "amount": { - "description": "Todo.", - "$ref": "#/definitions/SubstanceAmount" - }, - "degreeOfPolymerisation": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_DegreeOfPolymerisation" - }, - "type": "array" - }, - "structuralRepresentation": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstancePolymer_StructuralRepresentation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstancePolymer_DegreeOfPolymerisation": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "degree": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Todo.", - "$ref": "#/definitions/SubstanceAmount" - } - }, - "additionalProperties": false - }, - "SubstancePolymer_StructuralRepresentation": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "representation": { - "description": "Todo.", - "$ref": "#/definitions/string" - }, - "_representation": { - "description": "Extensions for representation", - "$ref": "#/definitions/Element" - }, - "attachment": { - "description": "Todo.", - "$ref": "#/definitions/Attachment" - } - }, - "additionalProperties": false - }, - "SubstanceProtein": { - "description": "A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.", - "properties": { - "resourceType": { - "description": "This is a SubstanceProtein resource", - "const": "SubstanceProtein" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sequenceType": { - "description": "The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.", - "$ref": "#/definitions/CodeableConcept" - }, - "numberOfSubunits": { - "description": "Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.", - "$ref": "#/definitions/integer" - }, - "_numberOfSubunits": { - "description": "Extensions for numberOfSubunits", - "$ref": "#/definitions/Element" - }, - "disulfideLinkage": { - "description": "The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_disulfideLinkage": { - "description": "Extensions for disulfideLinkage", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "subunit": { - "description": "This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.", - "items": { - "$ref": "#/definitions/SubstanceProtein_Subunit" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstanceProtein_Subunit": { - "description": "A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "subunit": { - "description": "Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts.", - "$ref": "#/definitions/integer" - }, - "_subunit": { - "description": "Extensions for subunit", - "$ref": "#/definitions/Element" - }, - "sequence": { - "description": "The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.", - "$ref": "#/definitions/string" - }, - "_sequence": { - "description": "Extensions for sequence", - "$ref": "#/definitions/Element" - }, - "length": { - "description": "Length of linear sequences of amino acids contained in the subunit.", - "$ref": "#/definitions/integer" - }, - "_length": { - "description": "Extensions for length", - "$ref": "#/definitions/Element" - }, - "sequenceAttachment": { - "description": "The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence.", - "$ref": "#/definitions/Attachment" - }, - "nTerminalModificationId": { - "description": "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.", - "$ref": "#/definitions/Identifier" - }, - "nTerminalModification": { - "description": "The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified.", - "$ref": "#/definitions/string" - }, - "_nTerminalModification": { - "description": "Extensions for nTerminalModification", - "$ref": "#/definitions/Element" - }, - "cTerminalModificationId": { - "description": "Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID.", - "$ref": "#/definitions/Identifier" - }, - "cTerminalModification": { - "description": "The modification at the C-terminal shall be specified.", - "$ref": "#/definitions/string" - }, - "_cTerminalModification": { - "description": "Extensions for cTerminalModification", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceReferenceInformation": { - "description": "Todo.", - "properties": { - "resourceType": { - "description": "This is a SubstanceReferenceInformation resource", - "const": "SubstanceReferenceInformation" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "comment": { - "description": "Todo.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "gene": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstanceReferenceInformation_Gene" - }, - "type": "array" - }, - "geneElement": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstanceReferenceInformation_GeneElement" - }, - "type": "array" - }, - "classification": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstanceReferenceInformation_Classification" - }, - "type": "array" - }, - "target": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/SubstanceReferenceInformation_Target" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstanceReferenceInformation_Gene": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "geneSequenceOrigin": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "gene": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceReferenceInformation_GeneElement": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "element": { - "description": "Todo.", - "$ref": "#/definitions/Identifier" - }, - "source": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceReferenceInformation_Classification": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "domain": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "classification": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "subtype": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "source": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceReferenceInformation_Target": { - "description": "Todo.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "target": { - "description": "Todo.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "interaction": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "organism": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "organismType": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "amountQuantity": { - "description": "Todo.", - "$ref": "#/definitions/Quantity" - }, - "amountRange": { - "description": "Todo.", - "$ref": "#/definitions/Range" - }, - "amountString": { - "description": "Todo.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_amountString": { - "description": "Extensions for amountString", - "$ref": "#/definitions/Element" - }, - "amountType": { - "description": "Todo.", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "Todo.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "resourceType": { - "description": "This is a SubstanceSourceMaterial resource", - "const": "SubstanceSourceMaterial" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "sourceMaterialClass": { - "description": "General high level classification of the source material specific to the origin of the material.", - "$ref": "#/definitions/CodeableConcept" - }, - "sourceMaterialType": { - "description": "The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.", - "$ref": "#/definitions/CodeableConcept" - }, - "sourceMaterialState": { - "description": "The state of the source material when extracted.", - "$ref": "#/definitions/CodeableConcept" - }, - "organismId": { - "description": "The unique identifier associated with the source material parent organism shall be specified.", - "$ref": "#/definitions/Identifier" - }, - "organismName": { - "description": "The organism accepted Scientific name shall be provided based on the organism taxonomy.", - "$ref": "#/definitions/string" - }, - "_organismName": { - "description": "Extensions for organismName", - "$ref": "#/definitions/Element" - }, - "parentSubstanceId": { - "description": "The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "parentSubstanceName": { - "description": "The parent substance of the Herbal Drug, or Herbal preparation.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_parentSubstanceName": { - "description": "Extensions for parentSubstanceName", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "countryOfOrigin": { - "description": "The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "geographicalLocation": { - "description": "The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_geographicalLocation": { - "description": "Extensions for geographicalLocation", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "developmentStage": { - "description": "Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).", - "$ref": "#/definitions/CodeableConcept" - }, - "fractionDescription": { - "description": "Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.", - "items": { - "$ref": "#/definitions/SubstanceSourceMaterial_FractionDescription" - }, - "type": "array" - }, - "organism": { - "description": "This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.", - "$ref": "#/definitions/SubstanceSourceMaterial_Organism" - }, - "partDescription": { - "description": "To do.", - "items": { - "$ref": "#/definitions/SubstanceSourceMaterial_PartDescription" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstanceSourceMaterial_FractionDescription": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "fraction": { - "description": "This element is capturing information about the fraction of a plant part, or human plasma for fractionation.", - "$ref": "#/definitions/string" - }, - "_fraction": { - "description": "Extensions for fraction", - "$ref": "#/definitions/Element" - }, - "materialType": { - "description": "The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial_Organism": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "family": { - "description": "The family of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "genus": { - "description": "The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies.", - "$ref": "#/definitions/CodeableConcept" - }, - "species": { - "description": "The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies.", - "$ref": "#/definitions/CodeableConcept" - }, - "intraspecificType": { - "description": "The Intraspecific type of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "intraspecificDescription": { - "description": "The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention.", - "$ref": "#/definitions/string" - }, - "_intraspecificDescription": { - "description": "Extensions for intraspecificDescription", - "$ref": "#/definitions/Element" - }, - "author": { - "description": "4.9.13.6.1 Author type (Conditional).", - "items": { - "$ref": "#/definitions/SubstanceSourceMaterial_Author" - }, - "type": "array" - }, - "hybrid": { - "description": "4.9.13.8.1 Hybrid species maternal organism ID (Optional).", - "$ref": "#/definitions/SubstanceSourceMaterial_Hybrid" - }, - "organismGeneral": { - "description": "4.9.13.7.1 Kingdom (Conditional).", - "$ref": "#/definitions/SubstanceSourceMaterial_OrganismGeneral" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial_Author": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "authorType": { - "description": "The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name.", - "$ref": "#/definitions/CodeableConcept" - }, - "authorDescription": { - "description": "The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank).", - "$ref": "#/definitions/string" - }, - "_authorDescription": { - "description": "Extensions for authorDescription", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial_Hybrid": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "maternalOrganismId": { - "description": "The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.", - "$ref": "#/definitions/string" - }, - "_maternalOrganismId": { - "description": "Extensions for maternalOrganismId", - "$ref": "#/definitions/Element" - }, - "maternalOrganismName": { - "description": "The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal.", - "$ref": "#/definitions/string" - }, - "_maternalOrganismName": { - "description": "Extensions for maternalOrganismName", - "$ref": "#/definitions/Element" - }, - "paternalOrganismId": { - "description": "The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary.", - "$ref": "#/definitions/string" - }, - "_paternalOrganismId": { - "description": "Extensions for paternalOrganismId", - "$ref": "#/definitions/Element" - }, - "paternalOrganismName": { - "description": "The name of the paternal species constituting the hybrid organism shall be specified.", - "$ref": "#/definitions/string" - }, - "_paternalOrganismName": { - "description": "Extensions for paternalOrganismName", - "$ref": "#/definitions/Element" - }, - "hybridType": { - "description": "The hybrid type of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial_OrganismGeneral": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "kingdom": { - "description": "The kingdom of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "phylum": { - "description": "The phylum of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "class": { - "description": "The class of an organism shall be specified.", - "$ref": "#/definitions/CodeableConcept" - }, - "order": { - "description": "The order of an organism shall be specified,.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "SubstanceSourceMaterial_PartDescription": { - "description": "Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "part": { - "description": "Entity of anatomical origin of source material within an organism.", - "$ref": "#/definitions/CodeableConcept" - }, - "partLocation": { - "description": "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply.", - "$ref": "#/definitions/CodeableConcept" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "resourceType": { - "description": "This is a SubstanceSpecification resource", - "const": "SubstanceSpecification" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier by which this substance is known.", - "$ref": "#/definitions/Identifier" - }, - "type": { - "description": "High level categorization, e.g. polymer or nucleic acid.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "Status of substance within the catalogue e.g. approved.", - "$ref": "#/definitions/CodeableConcept" - }, - "domain": { - "description": "If the substance applies to only human or veterinary use.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "Textual description of the substance.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "Supporting literature.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "comment": { - "description": "Textual comment about this record of a substance.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "moiety": { - "description": "Moiety, for structural modifications.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Moiety" - }, - "type": "array" - }, - "property": { - "description": "General specifications for this substance, including how it is related to other substances.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Property" - }, - "type": "array" - }, - "referenceInformation": { - "description": "General information detailing this substance.", - "$ref": "#/definitions/Reference" - }, - "structure": { - "description": "Structural information.", - "$ref": "#/definitions/SubstanceSpecification_Structure" - }, - "code": { - "description": "Codes associated with the substance.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Code" - }, - "type": "array" - }, - "name": { - "description": "Names applicable to this substance.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Name" - }, - "type": "array" - }, - "molecularWeight": { - "description": "The molecular weight or weight range (for proteins, polymers or nucleic acids).", - "items": { - "$ref": "#/definitions/SubstanceSpecification_MolecularWeight" - }, - "type": "array" - }, - "relationship": { - "description": "A link between this substance and another, with details of the relationship.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Relationship" - }, - "type": "array" - }, - "nucleicAcid": { - "description": "Data items specific to nucleic acids.", - "$ref": "#/definitions/Reference" - }, - "polymer": { - "description": "Data items specific to polymers.", - "$ref": "#/definitions/Reference" - }, - "protein": { - "description": "Data items specific to proteins.", - "$ref": "#/definitions/Reference" - }, - "sourceMaterial": { - "description": "Material or taxonomic/anatomical source for the substance.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SubstanceSpecification_Moiety": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "role": { - "description": "Role that the moiety is playing.", - "$ref": "#/definitions/CodeableConcept" - }, - "identifier": { - "description": "Identifier by which this moiety substance is known.", - "$ref": "#/definitions/Identifier" - }, - "name": { - "description": "Textual name for this moiety substance.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "stereochemistry": { - "description": "Stereochemistry type.", - "$ref": "#/definitions/CodeableConcept" - }, - "opticalActivity": { - "description": "Optical activity type.", - "$ref": "#/definitions/CodeableConcept" - }, - "molecularFormula": { - "description": "Molecular formula.", - "$ref": "#/definitions/string" - }, - "_molecularFormula": { - "description": "Extensions for molecularFormula", - "$ref": "#/definitions/Element" - }, - "amountQuantity": { - "description": "Quantitative value for this moiety.", - "$ref": "#/definitions/Quantity" - }, - "amountString": { - "description": "Quantitative value for this moiety.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_amountString": { - "description": "Extensions for amountString", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Property": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "category": { - "description": "A category for this property, e.g. Physical, Chemical, Enzymatic.", - "$ref": "#/definitions/CodeableConcept" - }, - "code": { - "description": "Property type e.g. viscosity, pH, isoelectric point.", - "$ref": "#/definitions/CodeableConcept" - }, - "parameters": { - "description": "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).", - "$ref": "#/definitions/string" - }, - "_parameters": { - "description": "Extensions for parameters", - "$ref": "#/definitions/Element" - }, - "definingSubstanceReference": { - "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).", - "$ref": "#/definitions/Reference" - }, - "definingSubstanceCodeableConcept": { - "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).", - "$ref": "#/definitions/CodeableConcept" - }, - "amountQuantity": { - "description": "Quantitative value for this property.", - "$ref": "#/definitions/Quantity" - }, - "amountString": { - "description": "Quantitative value for this property.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_amountString": { - "description": "Extensions for amountString", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Structure": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "stereochemistry": { - "description": "Stereochemistry type.", - "$ref": "#/definitions/CodeableConcept" - }, - "opticalActivity": { - "description": "Optical activity type.", - "$ref": "#/definitions/CodeableConcept" - }, - "molecularFormula": { - "description": "Molecular formula.", - "$ref": "#/definitions/string" - }, - "_molecularFormula": { - "description": "Extensions for molecularFormula", - "$ref": "#/definitions/Element" - }, - "molecularFormulaByMoiety": { - "description": "Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.", - "$ref": "#/definitions/string" - }, - "_molecularFormulaByMoiety": { - "description": "Extensions for molecularFormulaByMoiety", - "$ref": "#/definitions/Element" - }, - "isotope": { - "description": "Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Isotope" - }, - "type": "array" - }, - "molecularWeight": { - "description": "The molecular weight or weight range (for proteins, polymers or nucleic acids).", - "$ref": "#/definitions/SubstanceSpecification_MolecularWeight" - }, - "source": { - "description": "Supporting literature.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "representation": { - "description": "Molecular structural representation.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Representation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Isotope": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Substance identifier for each non-natural or radioisotope.", - "$ref": "#/definitions/Identifier" - }, - "name": { - "description": "Substance name for each non-natural or radioisotope.", - "$ref": "#/definitions/CodeableConcept" - }, - "substitution": { - "description": "The type of isotopic substitution present in a single substance.", - "$ref": "#/definitions/CodeableConcept" - }, - "halfLife": { - "description": "Half life - for a non-natural nuclide.", - "$ref": "#/definitions/Quantity" - }, - "molecularWeight": { - "description": "The molecular weight or weight range (for proteins, polymers or nucleic acids).", - "$ref": "#/definitions/SubstanceSpecification_MolecularWeight" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_MolecularWeight": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "method": { - "description": "The method by which the molecular weight was determined.", - "$ref": "#/definitions/CodeableConcept" - }, - "type": { - "description": "Type of molecular weight such as exact, average (also known as. number average), weight average.", - "$ref": "#/definitions/CodeableConcept" - }, - "amount": { - "description": "Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.", - "$ref": "#/definitions/Quantity" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Representation": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of structure (e.g. Full, Partial, Representative).", - "$ref": "#/definitions/CodeableConcept" - }, - "representation": { - "description": "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.", - "$ref": "#/definitions/string" - }, - "_representation": { - "description": "Extensions for representation", - "$ref": "#/definitions/Element" - }, - "attachment": { - "description": "An attached file with the structural representation.", - "$ref": "#/definitions/Attachment" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Code": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "The specific code.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "Status of the code assignment.", - "$ref": "#/definitions/CodeableConcept" - }, - "statusDate": { - "description": "The date at which the code status is changed as part of the terminology maintenance.", - "$ref": "#/definitions/dateTime" - }, - "_statusDate": { - "description": "Extensions for statusDate", - "$ref": "#/definitions/Element" - }, - "comment": { - "description": "Any comment can be provided in this field, if necessary.", - "$ref": "#/definitions/string" - }, - "_comment": { - "description": "Extensions for comment", - "$ref": "#/definitions/Element" - }, - "source": { - "description": "Supporting literature.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Name": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The actual name.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "type": { - "description": "Name type.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The status of the name.", - "$ref": "#/definitions/CodeableConcept" - }, - "preferred": { - "description": "If this is the preferred name for this substance.", - "$ref": "#/definitions/boolean" - }, - "_preferred": { - "description": "Extensions for preferred", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "Language of the name.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "domain": { - "description": "The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "jurisdiction": { - "description": "The jurisdiction where this name applies.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "synonym": { - "description": "A synonym of this name.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Name" - }, - "type": "array" - }, - "translation": { - "description": "A translation for this name.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Name" - }, - "type": "array" - }, - "official": { - "description": "Details of the official nature of this name.", - "items": { - "$ref": "#/definitions/SubstanceSpecification_Official" - }, - "type": "array" - }, - "source": { - "description": "Supporting literature.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Official": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "authority": { - "description": "Which authority uses this official name.", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The status of the official name.", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "Date of official name change.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "SubstanceSpecification_Relationship": { - "description": "The detailed description of a substance, typically at a level beyond what is used for prescribing.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "substanceReference": { - "description": "A pointer to another substance, as a resource or just a representational code.", - "$ref": "#/definitions/Reference" - }, - "substanceCodeableConcept": { - "description": "A pointer to another substance, as a resource or just a representational code.", - "$ref": "#/definitions/CodeableConcept" - }, - "relationship": { - "description": "For example \"salt to parent\", \"active moiety\", \"starting material\".", - "$ref": "#/definitions/CodeableConcept" - }, - "isDefining": { - "description": "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.", - "$ref": "#/definitions/boolean" - }, - "_isDefining": { - "description": "Extensions for isDefining", - "$ref": "#/definitions/Element" - }, - "amountQuantity": { - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.", - "$ref": "#/definitions/Quantity" - }, - "amountRange": { - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.", - "$ref": "#/definitions/Range" - }, - "amountRatio": { - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.", - "$ref": "#/definitions/Ratio" - }, - "amountString": { - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_amountString": { - "description": "Extensions for amountString", - "$ref": "#/definitions/Element" - }, - "amountRatioLowLimit": { - "description": "For use when the numeric.", - "$ref": "#/definitions/Ratio" - }, - "amountType": { - "description": "An operator for the amount, for example \"average\", \"approximately\", \"less than\".", - "$ref": "#/definitions/CodeableConcept" - }, - "source": { - "description": "Supporting literature.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "SupplyDelivery": { - "description": "Record of delivery of what is supplied.", - "properties": { - "resourceType": { - "description": "This is a SupplyDelivery resource", - "const": "SupplyDelivery" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the supply delivery event that is used to identify it across multiple disparate systems.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "basedOn": { - "description": "A plan, proposal or order that is fulfilled in whole or in part by this event.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "partOf": { - "description": "A larger event of which this particular event is a component or step.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "A code specifying the state of the dispense event.", - "enum": [ - "in-progress", - "completed", - "abandoned", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "A link to a resource representing the person whom the delivered item is for.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "suppliedItem": { - "description": "The item that is being delivered or has been supplied.", - "$ref": "#/definitions/SupplyDelivery_SuppliedItem" - }, - "occurrenceDateTime": { - "description": "The date or time(s) the activity occurred.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "The date or time(s) the activity occurred.", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "The date or time(s) the activity occurred.", - "$ref": "#/definitions/Timing" - }, - "supplier": { - "description": "The individual responsible for dispensing the medication, supplier or device.", - "$ref": "#/definitions/Reference" - }, - "destination": { - "description": "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.", - "$ref": "#/definitions/Reference" - }, - "receiver": { - "description": "Identifies the person who picked up the Supply.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "SupplyDelivery_SuppliedItem": { - "description": "Record of delivery of what is supplied.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "quantity": { - "description": "The amount of supply that has been dispensed. Includes unit of measure.", - "$ref": "#/definitions/Quantity" - }, - "itemCodeableConcept": { - "description": "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.", - "$ref": "#/definitions/CodeableConcept" - }, - "itemReference": { - "description": "Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "SupplyRequest": { - "description": "A record of a request for a medication, substance or device used in the healthcare setting.", - "properties": { - "resourceType": { - "description": "This is a SupplyRequest resource", - "const": "SupplyRequest" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "Status of the supply request.", - "enum": [ - "draft", - "active", - "suspended", - "cancelled", - "completed", - "entered-in-error", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "category": { - "description": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.", - "$ref": "#/definitions/CodeableConcept" - }, - "priority": { - "description": "Indicates how quickly this SupplyRequest should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "itemCodeableConcept": { - "description": "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.", - "$ref": "#/definitions/CodeableConcept" - }, - "itemReference": { - "description": "The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.", - "$ref": "#/definitions/Reference" - }, - "quantity": { - "description": "The amount that is being ordered of the indicated item.", - "$ref": "#/definitions/Quantity" - }, - "parameter": { - "description": "Specific parameters for the ordered item. For example, the size of the indicated item.", - "items": { - "$ref": "#/definitions/SupplyRequest_Parameter" - }, - "type": "array" - }, - "occurrenceDateTime": { - "description": "When the request should be fulfilled.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_occurrenceDateTime": { - "description": "Extensions for occurrenceDateTime", - "$ref": "#/definitions/Element" - }, - "occurrencePeriod": { - "description": "When the request should be fulfilled.", - "$ref": "#/definitions/Period" - }, - "occurrenceTiming": { - "description": "When the request should be fulfilled.", - "$ref": "#/definitions/Timing" - }, - "authoredOn": { - "description": "When the request was made.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The device, practitioner, etc. who initiated the request.", - "$ref": "#/definitions/Reference" - }, - "supplier": { - "description": "Who is intended to fulfill the request.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "reasonCode": { - "description": "The reason why the supply item was requested.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "reasonReference": { - "description": "The reason why the supply item was requested.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "deliverFrom": { - "description": "Where the supply is expected to come from.", - "$ref": "#/definitions/Reference" - }, - "deliverTo": { - "description": "Where the supply is destined to go.", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false, - "required": [ - "quantity", - "resourceType" - ] - }, - "SupplyRequest_Parameter": { - "description": "A record of a request for a medication, substance or device used in the healthcare setting.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "A code or string that identifies the device detail being asserted.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCodeableConcept": { - "description": "The value of the device detail.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueQuantity": { - "description": "The value of the device detail.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The value of the device detail.", - "$ref": "#/definitions/Range" - }, - "valueBoolean": { - "description": "The value of the device detail.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "Task": { - "description": "A task to be performed.", - "properties": { - "resourceType": { - "description": "This is a Task resource", - "const": "Task" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "The business identifier for this task.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", - "$ref": "#/definitions/canonical" - }, - "instantiatesUri": { - "description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", - "$ref": "#/definitions/uri" - }, - "_instantiatesUri": { - "description": "Extensions for instantiatesUri", - "$ref": "#/definitions/Element" - }, - "basedOn": { - "description": "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (\u003d BasedOn), a task is created to fulfill a procedureRequest ( \u003d FocusOn ) to collect a specimen from a patient.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "groupIdentifier": { - "description": "An identifier that links together multiple tasks and other requests that were created in the same context.", - "$ref": "#/definitions/Identifier" - }, - "partOf": { - "description": "Task that this particular task is part of.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "status": { - "description": "The current status of the task.", - "enum": [ - "draft", - "requested", - "received", - "accepted", - "rejected", - "ready", - "cancelled", - "in-progress", - "on-hold", - "failed", - "completed", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusReason": { - "description": "An explanation as to why this task is held, failed, was refused, etc.", - "$ref": "#/definitions/CodeableConcept" - }, - "businessStatus": { - "description": "Contains business-specific nuances of the business state.", - "$ref": "#/definitions/CodeableConcept" - }, - "intent": { - "description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.", - "enum": [ - "unknown", - "proposal", - "plan", - "order", - "original-order", - "reflex-order", - "filler-order", - "instance-order", - "option" - ] - }, - "_intent": { - "description": "Extensions for intent", - "$ref": "#/definitions/Element" - }, - "priority": { - "description": "Indicates how quickly the Task should be addressed with respect to other requests.", - "$ref": "#/definitions/code" - }, - "_priority": { - "description": "Extensions for priority", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "A name or code (or both) briefly describing what the task involves.", - "$ref": "#/definitions/CodeableConcept" - }, - "description": { - "description": "A free-text description of what is to be performed.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "focus": { - "description": "The request being actioned or the resource being manipulated by this task.", - "$ref": "#/definitions/Reference" - }, - "for": { - "description": "The entity who benefits from the performance of the service specified in the task (e.g., the patient).", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", - "$ref": "#/definitions/Reference" - }, - "executionPeriod": { - "description": "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", - "$ref": "#/definitions/Period" - }, - "authoredOn": { - "description": "The date and time this task was created.", - "$ref": "#/definitions/dateTime" - }, - "_authoredOn": { - "description": "Extensions for authoredOn", - "$ref": "#/definitions/Element" - }, - "lastModified": { - "description": "The date and time of last modification to this task.", - "$ref": "#/definitions/dateTime" - }, - "_lastModified": { - "description": "Extensions for lastModified", - "$ref": "#/definitions/Element" - }, - "requester": { - "description": "The creator of the task.", - "$ref": "#/definitions/Reference" - }, - "performerType": { - "description": "The kind of participant that should perform the task.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "owner": { - "description": "Individual organization or Device currently responsible for task execution.", - "$ref": "#/definitions/Reference" - }, - "location": { - "description": "Principal physical location where the this task is performed.", - "$ref": "#/definitions/Reference" - }, - "reasonCode": { - "description": "A description or code indicating why this task needs to be performed.", - "$ref": "#/definitions/CodeableConcept" - }, - "reasonReference": { - "description": "A resource reference indicating why this task needs to be performed.", - "$ref": "#/definitions/Reference" - }, - "insurance": { - "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "note": { - "description": "Free-text information captured about the task as it progresses.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - }, - "relevantHistory": { - "description": "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "restriction": { - "description": "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", - "$ref": "#/definitions/Task_Restriction" - }, - "input": { - "description": "Additional information that may be needed in the execution of the task.", - "items": { - "$ref": "#/definitions/Task_Input" - }, - "type": "array" - }, - "output": { - "description": "Outputs produced by the Task.", - "items": { - "$ref": "#/definitions/Task_Output" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "Task_Restriction": { - "description": "A task to be performed.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "repetitions": { - "description": "Indicates the number of times the requested action should occur.", - "$ref": "#/definitions/positiveInt" - }, - "_repetitions": { - "description": "Extensions for repetitions", - "$ref": "#/definitions/Element" - }, - "period": { - "description": "Over what time-period is fulfillment sought.", - "$ref": "#/definitions/Period" - }, - "recipient": { - "description": "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "Task_Input": { - "description": "A task to be performed.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "A code or description indicating how the input is intended to be used as part of the task execution.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueBase64Binary": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueCanonical": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueCanonical": { - "description": "Extensions for valueCanonical", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueId": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueInstant": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_valueInstant": { - "description": "Extensions for valueInstant", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueMarkdown": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueMarkdown": { - "description": "Extensions for valueMarkdown", - "$ref": "#/definitions/Element" - }, - "valueOid": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_valueOid": { - "description": "Extensions for valueOid", - "$ref": "#/definitions/Element" - }, - "valuePositiveInt": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_valuePositiveInt": { - "description": "Extensions for valuePositiveInt", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueUnsignedInt": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_valueUnsignedInt": { - "description": "Extensions for valueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueUrl": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUrl": { - "description": "Extensions for valueUrl", - "$ref": "#/definitions/Element" - }, - "valueUuid": { - "description": "The value of the input parameter as a basic type.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_valueUuid": { - "description": "Extensions for valueUuid", - "$ref": "#/definitions/Element" - }, - "valueAddress": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Address" - }, - "valueAge": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Age" - }, - "valueAnnotation": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Annotation" - }, - "valueAttachment": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Attachment" - }, - "valueCodeableConcept": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCoding": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Coding" - }, - "valueContactPoint": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/ContactPoint" - }, - "valueCount": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Count" - }, - "valueDistance": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Distance" - }, - "valueDuration": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Duration" - }, - "valueHumanName": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/HumanName" - }, - "valueIdentifier": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Identifier" - }, - "valueMoney": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Money" - }, - "valuePeriod": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Period" - }, - "valueQuantity": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Ratio" - }, - "valueReference": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Reference" - }, - "valueSampledData": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/SampledData" - }, - "valueSignature": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Signature" - }, - "valueTiming": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Timing" - }, - "valueContactDetail": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/ContactDetail" - }, - "valueContributor": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Contributor" - }, - "valueDataRequirement": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/DataRequirement" - }, - "valueExpression": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Expression" - }, - "valueParameterDefinition": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/ParameterDefinition" - }, - "valueRelatedArtifact": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/RelatedArtifact" - }, - "valueTriggerDefinition": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/TriggerDefinition" - }, - "valueUsageContext": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/UsageContext" - }, - "valueDosage": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Dosage" - }, - "valueMeta": { - "description": "The value of the input parameter as a basic type.", - "$ref": "#/definitions/Meta" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "Task_Output": { - "description": "A task to be performed.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The name of the Output parameter.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueBase64Binary": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$", - "type": "string" - }, - "_valueBase64Binary": { - "description": "Extensions for valueBase64Binary", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueCanonical": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueCanonical": { - "description": "Extensions for valueCanonical", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDate": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$", - "type": "string" - }, - "_valueDate": { - "description": "Extensions for valueDate", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueId": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[A-Za-z0-9\\-\\.]{1,64}$", - "type": "string" - }, - "_valueId": { - "description": "Extensions for valueId", - "$ref": "#/definitions/Element" - }, - "valueInstant": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$", - "type": "string" - }, - "_valueInstant": { - "description": "Extensions for valueInstant", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueMarkdown": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueMarkdown": { - "description": "Extensions for valueMarkdown", - "$ref": "#/definitions/Element" - }, - "valueOid": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$", - "type": "string" - }, - "_valueOid": { - "description": "Extensions for valueOid", - "$ref": "#/definitions/Element" - }, - "valuePositiveInt": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[1-9][0-9]*$", - "type": "number" - }, - "_valuePositiveInt": { - "description": "Extensions for valuePositiveInt", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueTime": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$", - "type": "string" - }, - "_valueTime": { - "description": "Extensions for valueTime", - "$ref": "#/definitions/Element" - }, - "valueUnsignedInt": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^[0]|([1-9][0-9]*)$", - "type": "number" - }, - "_valueUnsignedInt": { - "description": "Extensions for valueUnsignedInt", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueUrl": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUrl": { - "description": "Extensions for valueUrl", - "$ref": "#/definitions/Element" - }, - "valueUuid": { - "description": "The value of the Output parameter as a basic type.", - "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", - "type": "string" - }, - "_valueUuid": { - "description": "Extensions for valueUuid", - "$ref": "#/definitions/Element" - }, - "valueAddress": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Address" - }, - "valueAge": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Age" - }, - "valueAnnotation": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Annotation" - }, - "valueAttachment": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Attachment" - }, - "valueCodeableConcept": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/CodeableConcept" - }, - "valueCoding": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Coding" - }, - "valueContactPoint": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/ContactPoint" - }, - "valueCount": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Count" - }, - "valueDistance": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Distance" - }, - "valueDuration": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Duration" - }, - "valueHumanName": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/HumanName" - }, - "valueIdentifier": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Identifier" - }, - "valueMoney": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Money" - }, - "valuePeriod": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Period" - }, - "valueQuantity": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Quantity" - }, - "valueRange": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Range" - }, - "valueRatio": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Ratio" - }, - "valueReference": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Reference" - }, - "valueSampledData": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/SampledData" - }, - "valueSignature": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Signature" - }, - "valueTiming": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Timing" - }, - "valueContactDetail": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/ContactDetail" - }, - "valueContributor": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Contributor" - }, - "valueDataRequirement": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/DataRequirement" - }, - "valueExpression": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Expression" - }, - "valueParameterDefinition": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/ParameterDefinition" - }, - "valueRelatedArtifact": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/RelatedArtifact" - }, - "valueTriggerDefinition": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/TriggerDefinition" - }, - "valueUsageContext": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/UsageContext" - }, - "valueDosage": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Dosage" - }, - "valueMeta": { - "description": "The value of the Output parameter as a basic type.", - "$ref": "#/definitions/Meta" - } - }, - "additionalProperties": false, - "required": [ - "type" - ] - }, - "TerminologyCapabilities": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "resourceType": { - "description": "This is a TerminologyCapabilities resource", - "const": "TerminologyCapabilities" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the terminology capabilities.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this terminology capabilities. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the terminology capabilities.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the terminology capabilities from a consumer\u0027s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the terminology capabilities is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this terminology capabilities is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "kind": { - "description": "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).", - "$ref": "#/definitions/code" - }, - "_kind": { - "description": "Extensions for kind", - "$ref": "#/definitions/Element" - }, - "software": { - "description": "Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.", - "$ref": "#/definitions/TerminologyCapabilities_Software" - }, - "implementation": { - "description": "Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.", - "$ref": "#/definitions/TerminologyCapabilities_Implementation" - }, - "lockedDate": { - "description": "Whether the server supports lockedDate.", - "$ref": "#/definitions/boolean" - }, - "_lockedDate": { - "description": "Extensions for lockedDate", - "$ref": "#/definitions/Element" - }, - "codeSystem": { - "description": "Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.", - "items": { - "$ref": "#/definitions/TerminologyCapabilities_CodeSystem" - }, - "type": "array" - }, - "expansion": { - "description": "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.", - "$ref": "#/definitions/TerminologyCapabilities_Expansion" - }, - "codeSearch": { - "description": "The degree to which the server supports the code search parameter on ValueSet, if it is supported.", - "enum": [ - "explicit", - "all" - ] - }, - "_codeSearch": { - "description": "Extensions for codeSearch", - "$ref": "#/definitions/Element" - }, - "validateCode": { - "description": "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.", - "$ref": "#/definitions/TerminologyCapabilities_ValidateCode" - }, - "translation": { - "description": "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.", - "$ref": "#/definitions/TerminologyCapabilities_Translation" - }, - "closure": { - "description": "Whether the $closure operation is supported.", - "$ref": "#/definitions/TerminologyCapabilities_Closure" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "TerminologyCapabilities_Software": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name the software is known by.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version identifier for the software covered by this statement.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Implementation": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "description": { - "description": "Information about the specific installation that this terminology capability statement relates to.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "An absolute base URL for the implementation.", - "$ref": "#/definitions/url" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_CodeSystem": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "uri": { - "description": "URI for the Code System.", - "$ref": "#/definitions/canonical" - }, - "version": { - "description": "For the code system, a list of versions that are supported by the server.", - "items": { - "$ref": "#/definitions/TerminologyCapabilities_Version" - }, - "type": "array" - }, - "subsumption": { - "description": "True if subsumption is supported for this version of the code system.", - "$ref": "#/definitions/boolean" - }, - "_subsumption": { - "description": "Extensions for subsumption", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Version": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "For version-less code systems, there should be a single version with no identifier.", - "$ref": "#/definitions/string" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "isDefault": { - "description": "If this is the default version for this code system.", - "$ref": "#/definitions/boolean" - }, - "_isDefault": { - "description": "Extensions for isDefault", - "$ref": "#/definitions/Element" - }, - "compositional": { - "description": "If the compositional grammar defined by the code system is supported.", - "$ref": "#/definitions/boolean" - }, - "_compositional": { - "description": "Extensions for compositional", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "Language Displays supported.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_language": { - "description": "Extensions for language", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "filter": { - "description": "Filter Properties supported.", - "items": { - "$ref": "#/definitions/TerminologyCapabilities_Filter" - }, - "type": "array" - }, - "property": { - "description": "Properties supported for $lookup.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_property": { - "description": "Extensions for property", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Filter": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Code of the property supported.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "op": { - "description": "Operations supported for the property.", - "items": { - "$ref": "#/definitions/code" - }, - "type": "array" - }, - "_op": { - "description": "Extensions for op", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Expansion": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "hierarchical": { - "description": "Whether the server can return nested value sets.", - "$ref": "#/definitions/boolean" - }, - "_hierarchical": { - "description": "Extensions for hierarchical", - "$ref": "#/definitions/Element" - }, - "paging": { - "description": "Whether the server supports paging on expansion.", - "$ref": "#/definitions/boolean" - }, - "_paging": { - "description": "Extensions for paging", - "$ref": "#/definitions/Element" - }, - "incomplete": { - "description": "Allow request for incomplete expansions?", - "$ref": "#/definitions/boolean" - }, - "_incomplete": { - "description": "Extensions for incomplete", - "$ref": "#/definitions/Element" - }, - "parameter": { - "description": "Supported expansion parameter.", - "items": { - "$ref": "#/definitions/TerminologyCapabilities_Parameter" - }, - "type": "array" - }, - "textFilter": { - "description": "Documentation about text searching works.", - "$ref": "#/definitions/markdown" - }, - "_textFilter": { - "description": "Extensions for textFilter", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Parameter": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Expansion Parameter name.", - "$ref": "#/definitions/code" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "documentation": { - "description": "Description of support for parameter.", - "$ref": "#/definitions/string" - }, - "_documentation": { - "description": "Extensions for documentation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_ValidateCode": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "translations": { - "description": "Whether translations are validated.", - "$ref": "#/definitions/boolean" - }, - "_translations": { - "description": "Extensions for translations", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Translation": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "needsMap": { - "description": "Whether the client must identify the map.", - "$ref": "#/definitions/boolean" - }, - "_needsMap": { - "description": "Extensions for needsMap", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TerminologyCapabilities_Closure": { - "description": "A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "translation": { - "description": "If cross-system closure is supported.", - "$ref": "#/definitions/boolean" - }, - "_translation": { - "description": "Extensions for translation", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestReport": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "resourceType": { - "description": "This is a TestReport resource", - "const": "TestReport" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "Identifier for the TestScript assigned for external purposes outside the context of FHIR.", - "$ref": "#/definitions/Identifier" - }, - "name": { - "description": "A free text natural language name identifying the executed TestScript.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The current state of this test report.", - "enum": [ - "completed", - "in-progress", - "waiting", - "stopped", - "entered-in-error" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "testScript": { - "description": "Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.", - "$ref": "#/definitions/Reference" - }, - "result": { - "description": "The overall result from the execution of the TestScript.", - "enum": [ - "pass", - "fail", - "pending" - ] - }, - "_result": { - "description": "Extensions for result", - "$ref": "#/definitions/Element" - }, - "score": { - "description": "The final score (percentage of tests passed) resulting from the execution of the TestScript.", - "$ref": "#/definitions/decimal" - }, - "_score": { - "description": "Extensions for score", - "$ref": "#/definitions/Element" - }, - "tester": { - "description": "Name of the tester producing this report (Organization or individual).", - "$ref": "#/definitions/string" - }, - "_tester": { - "description": "Extensions for tester", - "$ref": "#/definitions/Element" - }, - "issued": { - "description": "When the TestScript was executed and this TestReport was generated.", - "$ref": "#/definitions/dateTime" - }, - "_issued": { - "description": "Extensions for issued", - "$ref": "#/definitions/Element" - }, - "participant": { - "description": "A participant in the test execution, either the execution engine, a client, or a server.", - "items": { - "$ref": "#/definitions/TestReport_Participant" - }, - "type": "array" - }, - "setup": { - "description": "The results of the series of required setup operations before the tests were executed.", - "$ref": "#/definitions/TestReport_Setup" - }, - "test": { - "description": "A test executed from the test script.", - "items": { - "$ref": "#/definitions/TestReport_Test" - }, - "type": "array" - }, - "teardown": { - "description": "The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).", - "$ref": "#/definitions/TestReport_Teardown" - } - }, - "additionalProperties": false, - "required": [ - "testScript", - "resourceType" - ] - }, - "TestReport_Participant": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "The type of participant.", - "enum": [ - "test-engine", - "client", - "server" - ] - }, - "_type": { - "description": "Extensions for type", - "$ref": "#/definitions/Element" - }, - "uri": { - "description": "The uri of the participant. An absolute URL is preferred.", - "$ref": "#/definitions/uri" - }, - "_uri": { - "description": "Extensions for uri", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The display name of the participant.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestReport_Setup": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "Action would contain either an operation or an assertion.", - "items": { - "$ref": "#/definitions/TestReport_Action" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestReport_Action": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "The operation performed.", - "$ref": "#/definitions/TestReport_Operation" - }, - "assert": { - "description": "The results of the assertion performed on the previous operations.", - "$ref": "#/definitions/TestReport_Assert" - } - }, - "additionalProperties": false - }, - "TestReport_Operation": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "result": { - "description": "The result of this operation.", - "enum": [ - "pass", - "skip", - "fail", - "warning", - "error" - ] - }, - "_result": { - "description": "Extensions for result", - "$ref": "#/definitions/Element" - }, - "message": { - "description": "An explanatory message associated with the result.", - "$ref": "#/definitions/markdown" - }, - "_message": { - "description": "Extensions for message", - "$ref": "#/definitions/Element" - }, - "detail": { - "description": "A link to further details on the result.", - "$ref": "#/definitions/uri" - }, - "_detail": { - "description": "Extensions for detail", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestReport_Assert": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "result": { - "description": "The result of this assertion.", - "enum": [ - "pass", - "skip", - "fail", - "warning", - "error" - ] - }, - "_result": { - "description": "Extensions for result", - "$ref": "#/definitions/Element" - }, - "message": { - "description": "An explanatory message associated with the result.", - "$ref": "#/definitions/markdown" - }, - "_message": { - "description": "Extensions for message", - "$ref": "#/definitions/Element" - }, - "detail": { - "description": "A link to further details on the result.", - "$ref": "#/definitions/string" - }, - "_detail": { - "description": "Extensions for detail", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestReport_Test": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of this test used for tracking/logging purposes by test engines.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A short description of the test used by test engines for tracking and reporting purposes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "action": { - "description": "Action would contain either an operation or an assertion.", - "items": { - "$ref": "#/definitions/TestReport_Action1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestReport_Action1": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "An operation would involve a REST request to a server.", - "$ref": "#/definitions/TestReport_Operation" - }, - "assert": { - "description": "The results of the assertion performed on the previous operations.", - "$ref": "#/definitions/TestReport_Assert" - } - }, - "additionalProperties": false - }, - "TestReport_Teardown": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "The teardown action will only contain an operation.", - "items": { - "$ref": "#/definitions/TestReport_Action2" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestReport_Action2": { - "description": "A summary of information based on the results of executing a TestScript.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "An operation would involve a REST request to a server.", - "$ref": "#/definitions/TestReport_Operation" - } - }, - "additionalProperties": false, - "required": [ - "operation" - ] - }, - "TestScript": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "resourceType": { - "description": "This is a TestScript resource", - "const": "TestScript" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "$ref": "#/definitions/Identifier" - }, - "version": { - "description": "The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the test script.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this test script. Enables tracking the life-cycle of the content.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the test script.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the test script from a consumer\u0027s perspective.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the test script is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "purpose": { - "description": "Explanation of why this test script is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "origin": { - "description": "An abstract server used in operations within this test script in the origin element.", - "items": { - "$ref": "#/definitions/TestScript_Origin" - }, - "type": "array" - }, - "destination": { - "description": "An abstract server used in operations within this test script in the destination element.", - "items": { - "$ref": "#/definitions/TestScript_Destination" - }, - "type": "array" - }, - "metadata": { - "description": "The required capability must exist and are assumed to function correctly on the FHIR server being tested.", - "$ref": "#/definitions/TestScript_Metadata" - }, - "fixture": { - "description": "Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.", - "items": { - "$ref": "#/definitions/TestScript_Fixture" - }, - "type": "array" - }, - "profile": { - "description": "Reference to the profile to be used for validation.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "variable": { - "description": "Variable is set based either on element value in response body or on header field value in the response headers.", - "items": { - "$ref": "#/definitions/TestScript_Variable" - }, - "type": "array" - }, - "setup": { - "description": "A series of required setup operations before tests are executed.", - "$ref": "#/definitions/TestScript_Setup" - }, - "test": { - "description": "A test in this script.", - "items": { - "$ref": "#/definitions/TestScript_Test" - }, - "type": "array" - }, - "teardown": { - "description": "A series of operations required to clean up after all the tests are executed (successfully or otherwise).", - "$ref": "#/definitions/TestScript_Teardown" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "TestScript_Origin": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "index": { - "description": "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.", - "$ref": "#/definitions/integer" - }, - "_index": { - "description": "Extensions for index", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "The type of origin profile the test system supports.", - "$ref": "#/definitions/Coding" - } - }, - "additionalProperties": false, - "required": [ - "profile" - ] - }, - "TestScript_Destination": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "index": { - "description": "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.", - "$ref": "#/definitions/integer" - }, - "_index": { - "description": "Extensions for index", - "$ref": "#/definitions/Element" - }, - "profile": { - "description": "The type of destination profile the test system supports.", - "$ref": "#/definitions/Coding" - } - }, - "additionalProperties": false, - "required": [ - "profile" - ] - }, - "TestScript_Metadata": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "link": { - "description": "A link to the FHIR specification that this test is covering.", - "items": { - "$ref": "#/definitions/TestScript_Link" - }, - "type": "array" - }, - "capability": { - "description": "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.", - "items": { - "$ref": "#/definitions/TestScript_Capability" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "capability" - ] - }, - "TestScript_Link": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "URL to a particular requirement or feature within the FHIR specification.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Short description of the link.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestScript_Capability": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "required": { - "description": "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.", - "$ref": "#/definitions/boolean" - }, - "_required": { - "description": "Extensions for required", - "$ref": "#/definitions/Element" - }, - "validated": { - "description": "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.", - "$ref": "#/definitions/boolean" - }, - "_validated": { - "description": "Extensions for validated", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "Description of the capabilities that this test script is requiring the server to support.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "origin": { - "description": "Which origin server these requirements apply to.", - "items": { - "$ref": "#/definitions/integer" - }, - "type": "array" - }, - "_origin": { - "description": "Extensions for origin", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "destination": { - "description": "Which server these requirements apply to.", - "$ref": "#/definitions/integer" - }, - "_destination": { - "description": "Extensions for destination", - "$ref": "#/definitions/Element" - }, - "link": { - "description": "Links to the FHIR specification that describes this interaction and the resources involved in more detail.", - "items": { - "$ref": "#/definitions/uri" - }, - "type": "array" - }, - "_link": { - "description": "Extensions for link", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "capabilities": { - "description": "Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.", - "$ref": "#/definitions/canonical" - } - }, - "additionalProperties": false, - "required": [ - "capabilities" - ] - }, - "TestScript_Fixture": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "autocreate": { - "description": "Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.", - "$ref": "#/definitions/boolean" - }, - "_autocreate": { - "description": "Extensions for autocreate", - "$ref": "#/definitions/Element" - }, - "autodelete": { - "description": "Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.", - "$ref": "#/definitions/boolean" - }, - "_autodelete": { - "description": "Extensions for autodelete", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "Reference to the resource (containing the contents of the resource needed for operations).", - "$ref": "#/definitions/Reference" - } - }, - "additionalProperties": false - }, - "TestScript_Variable": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Descriptive name for this variable.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "defaultValue": { - "description": "A default, hard-coded, or user-defined value for this variable.", - "$ref": "#/definitions/string" - }, - "_defaultValue": { - "description": "Extensions for defaultValue", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A free text natural language description of the variable and its purpose.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "headerField": { - "description": "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.", - "$ref": "#/definitions/string" - }, - "_headerField": { - "description": "Extensions for headerField", - "$ref": "#/definitions/Element" - }, - "hint": { - "description": "Displayable text string with hint help information to the user when entering a default value.", - "$ref": "#/definitions/string" - }, - "_hint": { - "description": "Extensions for hint", - "$ref": "#/definitions/Element" - }, - "path": { - "description": "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "sourceId": { - "description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.", - "$ref": "#/definitions/id" - }, - "_sourceId": { - "description": "Extensions for sourceId", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestScript_Setup": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "Action would contain either an operation or an assertion.", - "items": { - "$ref": "#/definitions/TestScript_Action" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestScript_Action": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "The operation to perform.", - "$ref": "#/definitions/TestScript_Operation" - }, - "assert": { - "description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately.", - "$ref": "#/definitions/TestScript_Assert" - } - }, - "additionalProperties": false - }, - "TestScript_Operation": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "type": { - "description": "Server interaction or operation type.", - "$ref": "#/definitions/Coding" - }, - "resource": { - "description": "The type of the resource. See http://build.fhir.org/resourcelist.html.", - "$ref": "#/definitions/code" - }, - "_resource": { - "description": "Extensions for resource", - "$ref": "#/definitions/Element" - }, - "label": { - "description": "The label would be used for tracking/logging purposes by test engines.", - "$ref": "#/definitions/string" - }, - "_label": { - "description": "Extensions for label", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "The description would be used by test engines for tracking and reporting purposes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "accept": { - "description": "The mime-type to use for RESTful operation in the \u0027Accept\u0027 header.", - "$ref": "#/definitions/code" - }, - "_accept": { - "description": "Extensions for accept", - "$ref": "#/definitions/Element" - }, - "contentType": { - "description": "The mime-type to use for RESTful operation in the \u0027Content-Type\u0027 header.", - "$ref": "#/definitions/code" - }, - "_contentType": { - "description": "Extensions for contentType", - "$ref": "#/definitions/Element" - }, - "destination": { - "description": "The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.", - "$ref": "#/definitions/integer" - }, - "_destination": { - "description": "Extensions for destination", - "$ref": "#/definitions/Element" - }, - "encodeRequestUrl": { - "description": "Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.", - "$ref": "#/definitions/boolean" - }, - "_encodeRequestUrl": { - "description": "Extensions for encodeRequestUrl", - "$ref": "#/definitions/Element" - }, - "method": { - "description": "The HTTP method the test engine MUST use for this operation regardless of any other operation details.", - "enum": [ - "delete", - "get", - "options", - "patch", - "post", - "put", - "head" - ] - }, - "_method": { - "description": "Extensions for method", - "$ref": "#/definitions/Element" - }, - "origin": { - "description": "The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.", - "$ref": "#/definitions/integer" - }, - "_origin": { - "description": "Extensions for origin", - "$ref": "#/definitions/Element" - }, - "params": { - "description": "Path plus parameters after [type]. Used to set parts of the request URL explicitly.", - "$ref": "#/definitions/string" - }, - "_params": { - "description": "Extensions for params", - "$ref": "#/definitions/Element" - }, - "requestHeader": { - "description": "Header elements would be used to set HTTP headers.", - "items": { - "$ref": "#/definitions/TestScript_RequestHeader" - }, - "type": "array" - }, - "requestId": { - "description": "The fixture id (maybe new) to map to the request.", - "$ref": "#/definitions/id" - }, - "_requestId": { - "description": "Extensions for requestId", - "$ref": "#/definitions/Element" - }, - "responseId": { - "description": "The fixture id (maybe new) to map to the response.", - "$ref": "#/definitions/id" - }, - "_responseId": { - "description": "Extensions for responseId", - "$ref": "#/definitions/Element" - }, - "sourceId": { - "description": "The id of the fixture used as the body of a PUT or POST request.", - "$ref": "#/definitions/id" - }, - "_sourceId": { - "description": "Extensions for sourceId", - "$ref": "#/definitions/Element" - }, - "targetId": { - "description": "Id of fixture used for extracting the [id], [type], and [vid] for GET requests.", - "$ref": "#/definitions/id" - }, - "_targetId": { - "description": "Extensions for targetId", - "$ref": "#/definitions/Element" - }, - "url": { - "description": "Complete request URL.", - "$ref": "#/definitions/string" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestScript_RequestHeader": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "field": { - "description": "The HTTP header field e.g. \"Accept\".", - "$ref": "#/definitions/string" - }, - "_field": { - "description": "Extensions for field", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The value of the header e.g. \"application/fhir+xml\".", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestScript_Assert": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "label": { - "description": "The label would be used for tracking/logging purposes by test engines.", - "$ref": "#/definitions/string" - }, - "_label": { - "description": "Extensions for label", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "The description would be used by test engines for tracking and reporting purposes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "direction": { - "description": "The direction to use for the assertion.", - "enum": [ - "response", - "request" - ] - }, - "_direction": { - "description": "Extensions for direction", - "$ref": "#/definitions/Element" - }, - "compareToSourceId": { - "description": "Id of the source fixture used as the contents to be evaluated by either the \"source/expression\" or \"sourceId/path\" definition.", - "$ref": "#/definitions/string" - }, - "_compareToSourceId": { - "description": "Extensions for compareToSourceId", - "$ref": "#/definitions/Element" - }, - "compareToSourceExpression": { - "description": "The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.", - "$ref": "#/definitions/string" - }, - "_compareToSourceExpression": { - "description": "Extensions for compareToSourceExpression", - "$ref": "#/definitions/Element" - }, - "compareToSourcePath": { - "description": "XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.", - "$ref": "#/definitions/string" - }, - "_compareToSourcePath": { - "description": "Extensions for compareToSourcePath", - "$ref": "#/definitions/Element" - }, - "contentType": { - "description": "The mime-type contents to compare against the request or response message \u0027Content-Type\u0027 header.", - "$ref": "#/definitions/code" - }, - "_contentType": { - "description": "Extensions for contentType", - "$ref": "#/definitions/Element" - }, - "expression": { - "description": "The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.", - "$ref": "#/definitions/string" - }, - "_expression": { - "description": "Extensions for expression", - "$ref": "#/definitions/Element" - }, - "headerField": { - "description": "The HTTP header field name e.g. \u0027Location\u0027.", - "$ref": "#/definitions/string" - }, - "_headerField": { - "description": "Extensions for headerField", - "$ref": "#/definitions/Element" - }, - "minimumId": { - "description": "The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.", - "$ref": "#/definitions/string" - }, - "_minimumId": { - "description": "Extensions for minimumId", - "$ref": "#/definitions/Element" - }, - "navigationLinks": { - "description": "Whether or not the test execution performs validation on the bundle navigation links.", - "$ref": "#/definitions/boolean" - }, - "_navigationLinks": { - "description": "Extensions for navigationLinks", - "$ref": "#/definitions/Element" - }, - "operator": { - "description": "The operator type defines the conditional behavior of the assert. If not defined, the default is equals.", - "enum": [ - "equals", - "notEquals", - "in", - "notIn", - "greaterThan", - "lessThan", - "empty", - "notEmpty", - "contains", - "notContains", - "eval" - ] - }, - "_operator": { - "description": "Extensions for operator", - "$ref": "#/definitions/Element" - }, - "path": { - "description": "The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.", - "$ref": "#/definitions/string" - }, - "_path": { - "description": "Extensions for path", - "$ref": "#/definitions/Element" - }, - "requestMethod": { - "description": "The request method or HTTP operation code to compare against that used by the client system under test.", - "enum": [ - "delete", - "get", - "options", - "patch", - "post", - "put", - "head" - ] - }, - "_requestMethod": { - "description": "Extensions for requestMethod", - "$ref": "#/definitions/Element" - }, - "requestURL": { - "description": "The value to use in a comparison against the request URL path string.", - "$ref": "#/definitions/string" - }, - "_requestURL": { - "description": "Extensions for requestURL", - "$ref": "#/definitions/Element" - }, - "resource": { - "description": "The type of the resource. See http://build.fhir.org/resourcelist.html.", - "$ref": "#/definitions/code" - }, - "_resource": { - "description": "Extensions for resource", - "$ref": "#/definitions/Element" - }, - "response": { - "description": "okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.", - "enum": [ - "okay", - "created", - "noContent", - "notModified", - "bad", - "forbidden", - "notFound", - "methodNotAllowed", - "conflict", - "gone", - "preconditionFailed", - "unprocessable" - ] - }, - "_response": { - "description": "Extensions for response", - "$ref": "#/definitions/Element" - }, - "responseCode": { - "description": "The value of the HTTP response code to be tested.", - "$ref": "#/definitions/string" - }, - "_responseCode": { - "description": "Extensions for responseCode", - "$ref": "#/definitions/Element" - }, - "sourceId": { - "description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against.", - "$ref": "#/definitions/id" - }, - "_sourceId": { - "description": "Extensions for sourceId", - "$ref": "#/definitions/Element" - }, - "validateProfileId": { - "description": "The ID of the Profile to validate against.", - "$ref": "#/definitions/id" - }, - "_validateProfileId": { - "description": "Extensions for validateProfileId", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The value to compare to.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - }, - "warningOnly": { - "description": "Whether or not the test execution will produce a warning only on error for this assert.", - "$ref": "#/definitions/boolean" - }, - "_warningOnly": { - "description": "Extensions for warningOnly", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "TestScript_Test": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "The name of this test used for tracking/logging purposes by test engines.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "description": { - "description": "A short description of the test used by test engines for tracking and reporting purposes.", - "$ref": "#/definitions/string" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "action": { - "description": "Action would contain either an operation or an assertion.", - "items": { - "$ref": "#/definitions/TestScript_Action1" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestScript_Action1": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "An operation would involve a REST request to a server.", - "$ref": "#/definitions/TestScript_Operation" - }, - "assert": { - "description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately.", - "$ref": "#/definitions/TestScript_Assert" - } - }, - "additionalProperties": false - }, - "TestScript_Teardown": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "action": { - "description": "The teardown action will only contain an operation.", - "items": { - "$ref": "#/definitions/TestScript_Action2" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "action" - ] - }, - "TestScript_Action2": { - "description": "A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "operation": { - "description": "An operation would involve a REST request to a server.", - "$ref": "#/definitions/TestScript_Operation" - } - }, - "additionalProperties": false, - "required": [ - "operation" - ] - }, - "ValueSet": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "resourceType": { - "description": "This is a ValueSet resource", - "const": "ValueSet" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "url": { - "description": "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.", - "$ref": "#/definitions/uri" - }, - "_url": { - "description": "Extensions for url", - "$ref": "#/definitions/Element" - }, - "identifier": { - "description": "A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "version": { - "description": "The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "name": { - "description": "A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "title": { - "description": "A short, descriptive, user-friendly title for the value set.", - "$ref": "#/definitions/string" - }, - "_title": { - "description": "Extensions for title", - "$ref": "#/definitions/Element" - }, - "status": { - "description": "The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.", - "enum": [ - "draft", - "active", - "retired", - "unknown" - ] - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "experimental": { - "description": "A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", - "$ref": "#/definitions/boolean" - }, - "_experimental": { - "description": "Extensions for experimental", - "$ref": "#/definitions/Element" - }, - "date": { - "description": "The date (and optionally time) when the value set was created or revised (e.g. the \u0027content logical definition\u0027).", - "$ref": "#/definitions/dateTime" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "publisher": { - "description": "The name of the organization or individual that published the value set.", - "$ref": "#/definitions/string" - }, - "_publisher": { - "description": "Extensions for publisher", - "$ref": "#/definitions/Element" - }, - "contact": { - "description": "Contact details to assist a user in finding and communicating with the publisher.", - "items": { - "$ref": "#/definitions/ContactDetail" - }, - "type": "array" - }, - "description": { - "description": "A free text natural language description of the value set from a consumer\u0027s perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.", - "$ref": "#/definitions/markdown" - }, - "_description": { - "description": "Extensions for description", - "$ref": "#/definitions/Element" - }, - "useContext": { - "description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.", - "items": { - "$ref": "#/definitions/UsageContext" - }, - "type": "array" - }, - "jurisdiction": { - "description": "A legal or geographic region in which the value set is intended to be used.", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "immutable": { - "description": "If this is set to \u0027true\u0027, then no new versions of the content logical definition can be created. Note: Other metadata might still change.", - "$ref": "#/definitions/boolean" - }, - "_immutable": { - "description": "Extensions for immutable", - "$ref": "#/definitions/Element" - }, - "purpose": { - "description": "Explanation of why this value set is needed and why it has been designed as it has.", - "$ref": "#/definitions/markdown" - }, - "_purpose": { - "description": "Extensions for purpose", - "$ref": "#/definitions/Element" - }, - "copyright": { - "description": "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.", - "$ref": "#/definitions/markdown" - }, - "_copyright": { - "description": "Extensions for copyright", - "$ref": "#/definitions/Element" - }, - "compose": { - "description": "A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).", - "$ref": "#/definitions/ValueSet_Compose" - }, - "expansion": { - "description": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.", - "$ref": "#/definitions/ValueSet_Expansion" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "ValueSet_Compose": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "lockedDate": { - "description": "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.", - "$ref": "#/definitions/date" - }, - "_lockedDate": { - "description": "Extensions for lockedDate", - "$ref": "#/definitions/Element" - }, - "inactive": { - "description": "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive \u003d true, inactive codes are to be included in the expansion, if inactive \u003d false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).", - "$ref": "#/definitions/boolean" - }, - "_inactive": { - "description": "Extensions for inactive", - "$ref": "#/definitions/Element" - }, - "include": { - "description": "Include one or more codes from a code system or other value set(s).", - "items": { - "$ref": "#/definitions/ValueSet_Include" - }, - "type": "array" - }, - "exclude": { - "description": "Exclude one or more codes from the value set based on code system filters and/or other value sets.", - "items": { - "$ref": "#/definitions/ValueSet_Include" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "include" - ] - }, - "ValueSet_Include": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "system": { - "description": "An absolute URI which is the code system from which the selected codes come from.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version of the code system that the codes are selected from, or the special version \u0027*\u0027 for all versions.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "concept": { - "description": "Specifies a concept to be included or excluded.", - "items": { - "$ref": "#/definitions/ValueSet_Concept" - }, - "type": "array" - }, - "filter": { - "description": "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.", - "items": { - "$ref": "#/definitions/ValueSet_Filter" - }, - "type": "array" - }, - "valueSet": { - "description": "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.", - "items": { - "$ref": "#/definitions/canonical" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ValueSet_Concept": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "code": { - "description": "Specifies a code for the concept to be included or excluded.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "designation": { - "description": "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.", - "items": { - "$ref": "#/definitions/ValueSet_Designation" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ValueSet_Designation": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "language": { - "description": "The language this designation is defined for.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "use": { - "description": "A code that represents types of uses of designations.", - "$ref": "#/definitions/Coding" - }, - "value": { - "description": "The text value for this designation.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ValueSet_Filter": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "property": { - "description": "A code that identifies a property or a filter defined in the code system.", - "$ref": "#/definitions/code" - }, - "_property": { - "description": "Extensions for property", - "$ref": "#/definitions/Element" - }, - "op": { - "description": "The kind of operation to perform as a part of the filter criteria.", - "enum": [ - "\u003d", - "is-a", - "descendent-of", - "is-not-a", - "regex", - "in", - "not-in", - "generalizes", - "exists" - ] - }, - "_op": { - "description": "Extensions for op", - "$ref": "#/definitions/Element" - }, - "value": { - "description": "The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is \u0027regex\u0027, or one of the values (true and false), when the operation is \u0027exists\u0027.", - "$ref": "#/definitions/string" - }, - "_value": { - "description": "Extensions for value", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ValueSet_Expansion": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.", - "$ref": "#/definitions/uri" - }, - "_identifier": { - "description": "Extensions for identifier", - "$ref": "#/definitions/Element" - }, - "timestamp": { - "description": "The time at which the expansion was produced by the expanding system.", - "$ref": "#/definitions/dateTime" - }, - "_timestamp": { - "description": "Extensions for timestamp", - "$ref": "#/definitions/Element" - }, - "total": { - "description": "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.", - "$ref": "#/definitions/integer" - }, - "_total": { - "description": "Extensions for total", - "$ref": "#/definitions/Element" - }, - "offset": { - "description": "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.", - "$ref": "#/definitions/integer" - }, - "_offset": { - "description": "Extensions for offset", - "$ref": "#/definitions/Element" - }, - "parameter": { - "description": "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.", - "items": { - "$ref": "#/definitions/ValueSet_Parameter" - }, - "type": "array" - }, - "contains": { - "description": "The codes that are contained in the value set expansion.", - "items": { - "$ref": "#/definitions/ValueSet_Contains" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "ValueSet_Parameter": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "name": { - "description": "Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.", - "$ref": "#/definitions/string" - }, - "_name": { - "description": "Extensions for name", - "$ref": "#/definitions/Element" - }, - "valueString": { - "description": "The value of the parameter.", - "pattern": "^[ \\r\\n\\t\\S]+$", - "type": "string" - }, - "_valueString": { - "description": "Extensions for valueString", - "$ref": "#/definitions/Element" - }, - "valueBoolean": { - "description": "The value of the parameter.", - "pattern": "^true|false$", - "type": "boolean" - }, - "_valueBoolean": { - "description": "Extensions for valueBoolean", - "$ref": "#/definitions/Element" - }, - "valueInteger": { - "description": "The value of the parameter.", - "pattern": "^-?([0]|([1-9][0-9]*))$", - "type": "number" - }, - "_valueInteger": { - "description": "Extensions for valueInteger", - "$ref": "#/definitions/Element" - }, - "valueDecimal": { - "description": "The value of the parameter.", - "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$", - "type": "number" - }, - "_valueDecimal": { - "description": "Extensions for valueDecimal", - "$ref": "#/definitions/Element" - }, - "valueUri": { - "description": "The value of the parameter.", - "pattern": "^\\S*$", - "type": "string" - }, - "_valueUri": { - "description": "Extensions for valueUri", - "$ref": "#/definitions/Element" - }, - "valueCode": { - "description": "The value of the parameter.", - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "_valueCode": { - "description": "Extensions for valueCode", - "$ref": "#/definitions/Element" - }, - "valueDateTime": { - "description": "The value of the parameter.", - "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$", - "type": "string" - }, - "_valueDateTime": { - "description": "Extensions for valueDateTime", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - }, - "ValueSet_Contains": { - "description": "A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "system": { - "description": "An absolute URI which is the code system in which the code for this item in the expansion is defined.", - "$ref": "#/definitions/uri" - }, - "_system": { - "description": "Extensions for system", - "$ref": "#/definitions/Element" - }, - "abstract": { - "description": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.", - "$ref": "#/definitions/boolean" - }, - "_abstract": { - "description": "Extensions for abstract", - "$ref": "#/definitions/Element" - }, - "inactive": { - "description": "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).", - "$ref": "#/definitions/boolean" - }, - "_inactive": { - "description": "Extensions for inactive", - "$ref": "#/definitions/Element" - }, - "version": { - "description": "The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", - "$ref": "#/definitions/string" - }, - "_version": { - "description": "Extensions for version", - "$ref": "#/definitions/Element" - }, - "code": { - "description": "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.", - "$ref": "#/definitions/code" - }, - "_code": { - "description": "Extensions for code", - "$ref": "#/definitions/Element" - }, - "display": { - "description": "The recommended display for this item in the expansion.", - "$ref": "#/definitions/string" - }, - "_display": { - "description": "Extensions for display", - "$ref": "#/definitions/Element" - }, - "designation": { - "description": "Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.", - "items": { - "$ref": "#/definitions/ValueSet_Designation" - }, - "type": "array" - }, - "contains": { - "description": "Other codes and entries contained under this entry in the hierarchy.", - "items": { - "$ref": "#/definitions/ValueSet_Contains" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "VerificationResult": { - "description": "Describes validation requirements, source(s), status and dates for one or more elements.", - "properties": { - "resourceType": { - "description": "This is a VerificationResult resource", - "const": "VerificationResult" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "target": { - "description": "A resource that was validated.", - "items": { - "$ref": "#/definitions/Reference" - }, - "type": "array" - }, - "targetLocation": { - "description": "The fhirpath location(s) within the resource that was validated.", - "items": { - "$ref": "#/definitions/string" - }, - "type": "array" - }, - "_targetLocation": { - "description": "Extensions for targetLocation", - "items": { - "$ref": "#/definitions/Element" - }, - "type": "array" - }, - "need": { - "description": "The frequency with which the target must be validated (none; initial; periodic).", - "$ref": "#/definitions/CodeableConcept" - }, - "status": { - "description": "The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "statusDate": { - "description": "When the validation status was updated.", - "$ref": "#/definitions/dateTime" - }, - "_statusDate": { - "description": "Extensions for statusDate", - "$ref": "#/definitions/Element" - }, - "validationType": { - "description": "What the target is validated against (nothing; primary source; multiple sources).", - "$ref": "#/definitions/CodeableConcept" - }, - "validationProcess": { - "description": "The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "frequency": { - "description": "Frequency of revalidation.", - "$ref": "#/definitions/Timing" - }, - "lastPerformed": { - "description": "The date/time validation was last completed (including failed validations).", - "$ref": "#/definitions/dateTime" - }, - "_lastPerformed": { - "description": "Extensions for lastPerformed", - "$ref": "#/definitions/Element" - }, - "nextScheduled": { - "description": "The date when target is next validated, if appropriate.", - "$ref": "#/definitions/date" - }, - "_nextScheduled": { - "description": "Extensions for nextScheduled", - "$ref": "#/definitions/Element" - }, - "failureAction": { - "description": "The result if validation fails (fatal; warning; record only; none).", - "$ref": "#/definitions/CodeableConcept" - }, - "primarySource": { - "description": "Information about the primary source(s) involved in validation.", - "items": { - "$ref": "#/definitions/VerificationResult_PrimarySource" - }, - "type": "array" - }, - "attestation": { - "description": "Information about the entity attesting to information.", - "$ref": "#/definitions/VerificationResult_Attestation" - }, - "validator": { - "description": "Information about the entity validating information.", - "items": { - "$ref": "#/definitions/VerificationResult_Validator" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "resourceType" - ] - }, - "VerificationResult_PrimarySource": { - "description": "Describes validation requirements, source(s), status and dates for one or more elements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "who": { - "description": "Reference to the primary source.", - "$ref": "#/definitions/Reference" - }, - "type": { - "description": "Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "communicationMethod": { - "description": "Method for communicating with the primary source (manual; API; Push).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - }, - "validationStatus": { - "description": "Status of the validation of the target against the primary source (successful; failed; unknown).", - "$ref": "#/definitions/CodeableConcept" - }, - "validationDate": { - "description": "When the target was validated against the primary source.", - "$ref": "#/definitions/dateTime" - }, - "_validationDate": { - "description": "Extensions for validationDate", - "$ref": "#/definitions/Element" - }, - "canPushUpdates": { - "description": "Ability of the primary source to push updates/alerts (yes; no; undetermined).", - "$ref": "#/definitions/CodeableConcept" - }, - "pushTypeAvailable": { - "description": "Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).", - "items": { - "$ref": "#/definitions/CodeableConcept" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "VerificationResult_Attestation": { - "description": "Describes validation requirements, source(s), status and dates for one or more elements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "who": { - "description": "The individual or organization attesting to information.", - "$ref": "#/definitions/Reference" - }, - "onBehalfOf": { - "description": "When the who is asserting on behalf of another (organization or individual).", - "$ref": "#/definitions/Reference" - }, - "communicationMethod": { - "description": "The method by which attested information was submitted/retrieved (manual; API; Push).", - "$ref": "#/definitions/CodeableConcept" - }, - "date": { - "description": "The date the information was attested to.", - "$ref": "#/definitions/date" - }, - "_date": { - "description": "Extensions for date", - "$ref": "#/definitions/Element" - }, - "sourceIdentityCertificate": { - "description": "A digital identity certificate associated with the attestation source.", - "$ref": "#/definitions/string" - }, - "_sourceIdentityCertificate": { - "description": "Extensions for sourceIdentityCertificate", - "$ref": "#/definitions/Element" - }, - "proxyIdentityCertificate": { - "description": "A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.", - "$ref": "#/definitions/string" - }, - "_proxyIdentityCertificate": { - "description": "Extensions for proxyIdentityCertificate", - "$ref": "#/definitions/Element" - }, - "proxySignature": { - "description": "Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.", - "$ref": "#/definitions/Signature" - }, - "sourceSignature": { - "description": "Signed assertion by the attestation source that they have attested to the information.", - "$ref": "#/definitions/Signature" - } - }, - "additionalProperties": false - }, - "VerificationResult_Validator": { - "description": "Describes validation requirements, source(s), status and dates for one or more elements.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "organization": { - "description": "Reference to the organization validating information.", - "$ref": "#/definitions/Reference" - }, - "identityCertificate": { - "description": "A digital identity certificate associated with the validator.", - "$ref": "#/definitions/string" - }, - "_identityCertificate": { - "description": "Extensions for identityCertificate", - "$ref": "#/definitions/Element" - }, - "attestationSignature": { - "description": "Signed assertion by the validator that they have validated the information.", - "$ref": "#/definitions/Signature" - } - }, - "additionalProperties": false, - "required": [ - "organization" - ] - }, - "VisionPrescription": { - "description": "An authorization for the provision of glasses and/or contact lenses to a patient.", - "properties": { - "resourceType": { - "description": "This is a VisionPrescription resource", - "const": "VisionPrescription" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "$ref": "#/definitions/id" - }, - "meta": { - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "$ref": "#/definitions/Meta" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "$ref": "#/definitions/uri" - }, - "_implicitRules": { - "description": "Extensions for implicitRules", - "$ref": "#/definitions/Element" - }, - "language": { - "description": "The base language in which the resource is written.", - "$ref": "#/definitions/code" - }, - "_language": { - "description": "Extensions for language", - "$ref": "#/definitions/Element" - }, - "text": { - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "$ref": "#/definitions/Narrative" - }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", - "items": { - "$ref": "#/definitions/ResourceList" - }, - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "identifier": { - "description": "A unique identifier assigned to this vision prescription.", - "items": { - "$ref": "#/definitions/Identifier" - }, - "type": "array" - }, - "status": { - "description": "The status of the resource instance.", - "$ref": "#/definitions/code" - }, - "_status": { - "description": "Extensions for status", - "$ref": "#/definitions/Element" - }, - "created": { - "description": "The date this resource was created.", - "$ref": "#/definitions/dateTime" - }, - "_created": { - "description": "Extensions for created", - "$ref": "#/definitions/Element" - }, - "patient": { - "description": "A resource reference to the person to whom the vision prescription applies.", - "$ref": "#/definitions/Reference" - }, - "encounter": { - "description": "A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.", - "$ref": "#/definitions/Reference" - }, - "dateWritten": { - "description": "The date (and perhaps time) when the prescription was written.", - "$ref": "#/definitions/dateTime" - }, - "_dateWritten": { - "description": "Extensions for dateWritten", - "$ref": "#/definitions/Element" - }, - "prescriber": { - "description": "The healthcare professional responsible for authorizing the prescription.", - "$ref": "#/definitions/Reference" - }, - "lensSpecification": { - "description": "Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.", - "items": { - "$ref": "#/definitions/VisionPrescription_LensSpecification" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "prescriber", - "patient", - "lensSpecification", - "resourceType" - ] - }, - "VisionPrescription_LensSpecification": { - "description": "An authorization for the provision of glasses and/or contact lenses to a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "product": { - "description": "Identifies the type of vision correction product which is required for the patient.", - "$ref": "#/definitions/CodeableConcept" - }, - "eye": { - "description": "The eye for which the lens specification applies.", - "enum": [ - "right", - "left" - ] - }, - "_eye": { - "description": "Extensions for eye", - "$ref": "#/definitions/Element" - }, - "sphere": { - "description": "Lens power measured in dioptres (0.25 units).", - "$ref": "#/definitions/decimal" - }, - "_sphere": { - "description": "Extensions for sphere", - "$ref": "#/definitions/Element" - }, - "cylinder": { - "description": "Power adjustment for astigmatism measured in dioptres (0.25 units).", - "$ref": "#/definitions/decimal" - }, - "_cylinder": { - "description": "Extensions for cylinder", - "$ref": "#/definitions/Element" - }, - "axis": { - "description": "Adjustment for astigmatism measured in integer degrees.", - "$ref": "#/definitions/integer" - }, - "_axis": { - "description": "Extensions for axis", - "$ref": "#/definitions/Element" - }, - "prism": { - "description": "Allows for adjustment on two axis.", - "items": { - "$ref": "#/definitions/VisionPrescription_Prism" - }, - "type": "array" - }, - "add": { - "description": "Power adjustment for multifocal lenses measured in dioptres (0.25 units).", - "$ref": "#/definitions/decimal" - }, - "_add": { - "description": "Extensions for add", - "$ref": "#/definitions/Element" - }, - "power": { - "description": "Contact lens power measured in dioptres (0.25 units).", - "$ref": "#/definitions/decimal" - }, - "_power": { - "description": "Extensions for power", - "$ref": "#/definitions/Element" - }, - "backCurve": { - "description": "Back curvature measured in millimetres.", - "$ref": "#/definitions/decimal" - }, - "_backCurve": { - "description": "Extensions for backCurve", - "$ref": "#/definitions/Element" - }, - "diameter": { - "description": "Contact lens diameter measured in millimetres.", - "$ref": "#/definitions/decimal" - }, - "_diameter": { - "description": "Extensions for diameter", - "$ref": "#/definitions/Element" - }, - "duration": { - "description": "The recommended maximum wear period for the lens.", - "$ref": "#/definitions/Quantity" - }, - "color": { - "description": "Special color or pattern.", - "$ref": "#/definitions/string" - }, - "_color": { - "description": "Extensions for color", - "$ref": "#/definitions/Element" - }, - "brand": { - "description": "Brand recommendations or restrictions.", - "$ref": "#/definitions/string" - }, - "_brand": { - "description": "Extensions for brand", - "$ref": "#/definitions/Element" - }, - "note": { - "description": "Notes for special requirements such as coatings and lens materials.", - "items": { - "$ref": "#/definitions/Annotation" - }, - "type": "array" - } - }, - "additionalProperties": false, - "required": [ - "product" - ] - }, - "VisionPrescription_Prism": { - "description": "An authorization for the provision of glasses and/or contact lenses to a patient.", - "properties": { - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "$ref": "#/definitions/string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "items": { - "$ref": "#/definitions/Extension" - }, - "type": "array" - }, - "amount": { - "description": "Amount of prism to compensate for eye alignment in fractional units.", - "$ref": "#/definitions/decimal" - }, - "_amount": { - "description": "Extensions for amount", - "$ref": "#/definitions/Element" - }, - "base": { - "description": "The relative base, or reference lens edge, for the prism.", - "enum": [ - "up", - "down", - "in", - "out" - ] - }, - "_base": { - "description": "Extensions for base", - "$ref": "#/definitions/Element" - } - }, - "additionalProperties": false - } - } - } \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/asyncapi-2_0.json b/test/blackbox/docs/JsonSchemaDraft-7/asyncapi-2_0.json deleted file mode 100644 index 0bebe8596a..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/asyncapi-2_0.json +++ /dev/null @@ -1,1370 +0,0 @@ -{ - "title": "AsyncAPI 2.0.0 schema.", - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "asyncapi", - "info", - "channels" - ], - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "asyncapi": { - "type": "string", - "enum": [ - "2.0.0" - ], - "description": "The AsyncAPI specification version of this document." - }, - "id": { - "type": "string", - "description": "A unique id representing the application.", - "format": "uri" - }, - "info": { - "$ref": "#/definitions/info" - }, - "servers": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/server" - } - }, - "defaultContentType": { - "type": "string" - }, - "channels": { - "$ref": "#/definitions/channels" - }, - "components": { - "$ref": "#/definitions/components" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - } - }, - "definitions": { - "Reference": { - "type": "object", - "required": [ - "$ref" - ], - "properties": { - "$ref": { - "$ref": "#/definitions/ReferenceObject" - } - } - }, - "ReferenceObject": { - "type": "string", - "format": "uri-reference" - }, - "info": { - "type": "object", - "description": "General information about the API.", - "required": [ - "version", - "title" - ], - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "title": { - "type": "string", - "description": "A unique and precise title of the API." - }, - "version": { - "type": "string", - "description": "A semantic version number of the API." - }, - "description": { - "type": "string", - "description": "A longer description of the API. Should be different from the title. CommonMark is allowed." - }, - "termsOfService": { - "type": "string", - "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "format": "uri" - }, - "contact": { - "$ref": "#/definitions/contact" - }, - "license": { - "$ref": "#/definitions/license" - } - } - }, - "contact": { - "type": "object", - "description": "Contact information for the owners of the API.", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The identifying name of the contact person/organization." - }, - "url": { - "type": "string", - "description": "The URL pointing to the contact information.", - "format": "uri" - }, - "email": { - "type": "string", - "description": "The email address of the contact person/organization.", - "format": "email" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - } - }, - "license": { - "type": "object", - "required": [ - "name" - ], - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the license type. It's encouraged to use an OSI compatible license." - }, - "url": { - "type": "string", - "description": "The URL pointing to the license.", - "format": "uri" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - } - }, - "server": { - "type": "object", - "description": "An object representing a Server.", - "required": [ - "url", - "protocol" - ], - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "protocol": { - "type": "string", - "description": "The transfer protocol." - }, - "protocolVersion": { - "type": "string" - }, - "variables": { - "$ref": "#/definitions/serverVariables" - }, - "security": { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityRequirement" - } - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - } - } - }, - "serverVariables": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/serverVariable" - } - }, - "serverVariable": { - "type": "object", - "description": "An object representing a Server Variable for server URL template substitution.", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "enum": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - }, - "default": { - "type": "string" - }, - "description": { - "type": "string" - }, - "examples": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "channels": { - "type": "object", - "propertyNames": { - "type": "string", - "format": "uri-template", - "minLength": 1 - }, - "additionalProperties": { - "$ref": "#/definitions/channelItem" - } - }, - "components": { - "type": "object", - "description": "An object to hold a set of reusable objects for different aspects of the AsyncAPI Specification.", - "additionalProperties": false, - "properties": { - "schemas": { - "$ref": "#/definitions/schemas" - }, - "messages": { - "$ref": "#/definitions/messages" - }, - "securitySchemes": { - "type": "object", - "patternProperties": { - "^[\\w\\d\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/SecurityScheme" - } - ] - } - } - }, - "parameters": { - "$ref": "#/definitions/parameters" - }, - "correlationIds": { - "type": "object", - "patternProperties": { - "^[\\w\\d\\.\\-_]+$": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/correlationId" - } - ] - } - } - }, - "operationTraits": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/operationTrait" - } - }, - "messageTraits": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/messageTrait" - } - }, - "serverBindings": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/bindingsObject" - } - }, - "channelBindings": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/bindingsObject" - } - }, - "operationBindings": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/bindingsObject" - } - }, - "messageBindings": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/bindingsObject" - } - } - } - }, - "schemas": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/schema" - }, - "description": "JSON objects describing schemas the API uses." - }, - "messages": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/message" - }, - "description": "JSON objects describing the messages being consumed and produced by the API." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/parameter" - }, - "description": "JSON objects describing re-usable channel parameters." - }, - "schema": { - "allOf": [ - { - "$ref": "http://json-schema.org/draft-07/schema#" - }, - { - "type": "object", - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "additionalProperties": { - "anyOf": [ - { - "$ref": "#/definitions/schema" - }, - { - "type": "boolean" - } - ], - "default": {} - }, - "items": { - "anyOf": [ - { - "$ref": "#/definitions/schema" - }, - { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - } - ], - "default": {} - }, - "allOf": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - }, - "oneOf": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - }, - "anyOf": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/schema" - } - }, - "not": { - "$ref": "#/definitions/schema" - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/schema" - }, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/schema" - }, - "default": {} - }, - "propertyNames": { - "$ref": "#/definitions/schema" - }, - "contains": { - "$ref": "#/definitions/schema" - }, - "discriminator": { - "type": "string" - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "deprecated": { - "type": "boolean", - "default": false - } - } - } - ] - }, - "externalDocs": { - "type": "object", - "additionalProperties": false, - "description": "information about external documentation", - "required": [ - "url" - ], - "properties": { - "description": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - } - }, - "channelItem": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "$ref": { - "$ref": "#/definitions/ReferenceObject" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/parameter" - } - }, - "description": { - "type": "string", - "description": "A description of the channel." - }, - "publish": { - "$ref": "#/definitions/operation" - }, - "subscribe": { - "$ref": "#/definitions/operation" - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - } - } - }, - "parameter": { - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "description": { - "type": "string", - "description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed." - }, - "schema": { - "$ref": "#/definitions/schema" - }, - "location": { - "type": "string", - "description": "A runtime expression that specifies the location of the parameter value", - "pattern": "^\\$message\\.(header|payload)\\#(\\/(([^\\/~])|(~[01]))*)*" - }, - "$ref": { - "$ref": "#/definitions/ReferenceObject" - } - } - }, - "operation": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "traits": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/operationTrait" - }, - { - "type": "array", - "items": [ - { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/operationTrait" - } - ] - }, - { - "type": "object", - "additionalItems": true - } - ] - } - ] - } - }, - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "operationId": { - "type": "string" - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - }, - "message": { - "$ref": "#/definitions/message" - } - } - }, - "message": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "oneOf": [ - { - "type": "object", - "required": [ - "oneOf" - ], - "additionalProperties": false, - "properties": { - "oneOf": { - "type": "array", - "items": { - "$ref": "#/definitions/message" - } - } - } - }, - { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "schemaFormat": { - "type": "string" - }, - "contentType": { - "type": "string" - }, - "headers": { - "allOf": [ - { "$ref": "#/definitions/schema" }, - { "properties": { - "type": { "const": "object" } - } - } - ] - }, - "payload": {}, - "correlationId": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/correlationId" - } - ] - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "summary": { - "type": "string", - "description": "A brief summary of the message." - }, - "name": { - "type": "string", - "description": "Name of the message." - }, - "title": { - "type": "string", - "description": "A human-friendly title for the message." - }, - "description": { - "type": "string", - "description": "A longer description of the message. CommonMark is allowed." - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "examples": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "headers": { - "type": "object" - }, - "payload": {} - } - } - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - }, - "traits": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/messageTrait" - }, - { - "type": "array", - "items": [ - { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/messageTrait" - } - ] - }, - { - "type": "object", - "additionalItems": true - } - ] - } - ] - } - } - } - } - ] - } - ] - }, - "bindingsObject": { - "type": "object", - "additionalProperties": true, - "properties": { - "http": {}, - "ws": {}, - "amqp": {}, - "amqp1": {}, - "mqtt": {}, - "mqtt5": {}, - "kafka": {}, - "nats": {}, - "jms": {}, - "sns": {}, - "sqs": {}, - "stomp": {}, - "redis": {}, - "mercure": {} - } - }, - "correlationId": { - "type": "object", - "required": [ - "location" - ], - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "description": { - "type": "string", - "description": "A optional description of the correlation ID. GitHub Flavored Markdown is allowed." - }, - "location": { - "type": "string", - "description": "A runtime expression that specifies the location of the correlation ID", - "pattern": "^\\$message\\.(header|payload)\\#(\\/(([^\\/~])|(~[01]))*)*" - } - } - }, - "specificationExtension": { - "description": "Any property starting with x- is valid.", - "additionalProperties": true, - "additionalItems": true - }, - "tag": { - "type": "object", - "additionalProperties": false, - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - } - }, - "operationTrait": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "summary": { - "type": "string" - }, - "description": { - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "operationId": { - "type": "string" - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - } - } - }, - "messageTrait": { - "type": "object", - "additionalProperties": false, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "properties": { - "schemaFormat": { - "type": "string" - }, - "contentType": { - "type": "string" - }, - "headers": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/schema" - } - ] - }, - "correlationId": { - "oneOf": [ - { - "$ref": "#/definitions/Reference" - }, - { - "$ref": "#/definitions/correlationId" - } - ] - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/tag" - }, - "uniqueItems": true - }, - "summary": { - "type": "string", - "description": "A brief summary of the message." - }, - "name": { - "type": "string", - "description": "Name of the message." - }, - "title": { - "type": "string", - "description": "A human-friendly title for the message." - }, - "description": { - "type": "string", - "description": "A longer description of the message. CommonMark is allowed." - }, - "externalDocs": { - "$ref": "#/definitions/externalDocs" - }, - "deprecated": { - "type": "boolean", - "default": false - }, - "examples": { - "type": "array", - "items": { - "type": "object" - } - }, - "bindings": { - "$ref": "#/definitions/bindingsObject" - } - } - }, - "SecurityScheme": { - "oneOf": [ - { - "$ref": "#/definitions/userPassword" - }, - { - "$ref": "#/definitions/apiKey" - }, - { - "$ref": "#/definitions/X509" - }, - { - "$ref": "#/definitions/symmetricEncryption" - }, - { - "$ref": "#/definitions/asymmetricEncryption" - }, - { - "$ref": "#/definitions/HTTPSecurityScheme" - }, - { - "$ref": "#/definitions/oauth2Flows" - }, - { - "$ref": "#/definitions/openIdConnect" - } - ] - }, - "userPassword": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "userPassword" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "apiKey": { - "type": "object", - "required": [ - "type", - "in" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "apiKey" - ] - }, - "in": { - "type": "string", - "enum": [ - "user", - "password" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "X509": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "X509" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "symmetricEncryption": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "symmetricEncryption" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "asymmetricEncryption": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "asymmetricEncryption" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "HTTPSecurityScheme": { - "oneOf": [ - { - "$ref": "#/definitions/NonBearerHTTPSecurityScheme" - }, - { - "$ref": "#/definitions/BearerHTTPSecurityScheme" - }, - { - "$ref": "#/definitions/APIKeyHTTPSecurityScheme" - } - ] - }, - "NonBearerHTTPSecurityScheme": { - "not": { - "type": "object", - "properties": { - "scheme": { - "type": "string", - "enum": [ - "bearer" - ] - } - } - }, - "type": "object", - "required": [ - "scheme", - "type" - ], - "properties": { - "scheme": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "http" - ] - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "BearerHTTPSecurityScheme": { - "type": "object", - "required": [ - "type", - "scheme" - ], - "properties": { - "scheme": { - "type": "string", - "enum": [ - "bearer" - ] - }, - "bearerFormat": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "http" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "APIKeyHTTPSecurityScheme": { - "type": "object", - "required": [ - "type", - "name", - "in" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "httpApiKey" - ] - }, - "name": { - "type": "string" - }, - "in": { - "type": "string", - "enum": [ - "header", - "query", - "cookie" - ] - }, - "description": { - "type": "string" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "oauth2Flows": { - "type": "object", - "required": [ - "type", - "flows" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "oauth2" - ] - }, - "description": { - "type": "string" - }, - "flows": { - "type": "object", - "properties": { - "implicit": { - "allOf": [ - { - "$ref": "#/definitions/oauth2Flow" - }, - { - "required": [ - "authorizationUrl", - "scopes" - ] - }, - { - "not": { - "required": [ - "tokenUrl" - ] - } - } - ] - }, - "password": { - "allOf": [ - { - "$ref": "#/definitions/oauth2Flow" - }, - { - "required": [ - "tokenUrl", - "scopes" - ] - }, - { - "not": { - "required": [ - "authorizationUrl" - ] - } - } - ] - }, - "clientCredentials": { - "allOf": [ - { - "$ref": "#/definitions/oauth2Flow" - }, - { - "required": [ - "tokenUrl", - "scopes" - ] - }, - { - "not": { - "required": [ - "authorizationUrl" - ] - } - } - ] - }, - "authorizationCode": { - "allOf": [ - { - "$ref": "#/definitions/oauth2Flow" - }, - { - "required": [ - "authorizationUrl", - "tokenUrl", - "scopes" - ] - } - ] - } - }, - "additionalProperties": false - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - } - }, - "oauth2Flow": { - "type": "object", - "properties": { - "authorizationUrl": { - "type": "string", - "format": "uri" - }, - "tokenUrl": { - "type": "string", - "format": "uri" - }, - "refreshUrl": { - "type": "string", - "format": "uri" - }, - "scopes": { - "$ref": "#/definitions/oauth2Scopes" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "oauth2Scopes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "openIdConnect": { - "type": "object", - "required": [ - "type", - "openIdConnectUrl" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "openIdConnect" - ] - }, - "description": { - "type": "string" - }, - "openIdConnectUrl": { - "type": "string", - "format": "uri" - } - }, - "patternProperties": { - "^x-[\\w\\d\\.\\-\\_]+$": { - "$ref": "#/definitions/specificationExtension" - } - }, - "additionalProperties": false - }, - "SecurityRequirement": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true - } - } - } - } - \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/better-code-hub-config.json b/test/blackbox/docs/JsonSchemaDraft-7/better-code-hub-config.json deleted file mode 100644 index f0296ee8dc..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/better-code-hub-config.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$comment": "https://www.bettercodehub.com/docs/configuration-manual", - "title": "Better Code Hub", - "description": "Configuration file for Better Code Hub to override the default configuration.", - "type": "object", - "additionalProperties": false, - "definitions": { - "supportedProgrammingLanguage": { - "type": "string", - "enum": [ - "csharp", - "cpp", - "go", - "groovy", - "java", - "javascript", - "objectivec", - "perl", - "php", - "python", - "ruby", - "scala", - "script", - "solidity", - "swift", - "typescript", - "kotlin" - ] - }, - "excludeFileFilter": { - "title": "Exclude", - "type": "array", - "items": { - "title": "Pattern", - "description": "A regular expression for the path(s) to exclude.", - "type": "string" - } - }, - "fileFilter": { - "type": "object", - "additionalProperties": false, - "properties": { - "include": { - "title": "Include", - "type": "array", - "items": { - "title": "Pattern", - "description": "A regular expression for the path(s) to include.", - "type": "string" - } - }, - "exclude": { - "$ref": "#/definitions/excludeFileFilter" - } - } - } - }, - "properties": { - "component_depth": { - "title": "Component Depth", - "type": "integer", - "default": 1 - }, - "languages": { - "title": "Languages", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/supportedProgrammingLanguage" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "title": "Name", - "$ref": "#/definitions/supportedProgrammingLanguage" - }, - "production": { - "title": "Production", - "$ref": "#/definitions/fileFilter" - }, - "test": { - "title": "Test", - "$ref": "#/definitions/fileFilter" - } - } - } - ] - } - }, - "exclude": { - "$ref": "#/definitions/excludeFileFilter" - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/draft-7-core.json b/test/blackbox/docs/JsonSchemaDraft-7/draft-7-core.json deleted file mode 100644 index fb92c7f756..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/draft-7-core.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "http://json-schema.org/draft-07/schema#", - "title": "Core schema meta-schema", - "definitions": { - "schemaArray": { - "type": "array", - "minItems": 1, - "items": { "$ref": "#" } - }, - "nonNegativeInteger": { - "type": "integer", - "minimum": 0 - }, - "nonNegativeIntegerDefault0": { - "allOf": [ - { "$ref": "#/definitions/nonNegativeInteger" }, - { "default": 0 } - ] - }, - "simpleTypes": { - "enum": [ - "array", - "boolean", - "integer", - "null", - "number", - "object", - "string" - ] - }, - "stringArray": { - "type": "array", - "items": { "type": "string" }, - "uniqueItems": true, - "default": [] - } - }, - "type": ["object", "boolean"], - "properties": { - "$id": { - "type": "string", - "format": "uri-reference" - }, - "$schema": { - "type": "string", - "format": "uri" - }, - "$ref": { - "type": "string", - "format": "uri-reference" - }, - "$comment": { - "type": "string" - }, - "title": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default": true, - "readOnly": { - "type": "boolean", - "default": false - }, - "writeOnly": { - "type": "boolean", - "default": false - }, - "examples": { - "type": "array", - "items": true - }, - "multipleOf": { - "type": "number", - "exclusiveMinimum": 0 - }, - "maximum": { - "type": "number" - }, - "exclusiveMaximum": { - "type": "number" - }, - "minimum": { - "type": "number" - }, - "exclusiveMinimum": { - "type": "number" - }, - "maxLength": { "$ref": "#/definitions/nonNegativeInteger" }, - "minLength": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "pattern": { - "type": "string", - "format": "regex" - }, - "additionalItems": { "$ref": "#" }, - "items": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/schemaArray" } - ], - "default": true - }, - "maxItems": { "$ref": "#/definitions/nonNegativeInteger" }, - "minItems": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "uniqueItems": { - "type": "boolean", - "default": false - }, - "contains": { "$ref": "#" }, - "maxProperties": { "$ref": "#/definitions/nonNegativeInteger" }, - "minProperties": { "$ref": "#/definitions/nonNegativeIntegerDefault0" }, - "required": { "$ref": "#/definitions/stringArray" }, - "additionalProperties": { "$ref": "#" }, - "definitions": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "properties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "default": {} - }, - "patternProperties": { - "type": "object", - "additionalProperties": { "$ref": "#" }, - "propertyNames": { "format": "regex" }, - "default": {} - }, - "dependencies": { - "type": "object", - "additionalProperties": { - "anyOf": [ - { "$ref": "#" }, - { "$ref": "#/definitions/stringArray" } - ] - } - }, - "propertyNames": { "$ref": "#" }, - "const": true, - "enum": { - "type": "array", - "items": true, - "minItems": 1, - "uniqueItems": true - }, - "type": { - "anyOf": [ - { "$ref": "#/definitions/simpleTypes" }, - { - "type": "array", - "items": { "$ref": "#/definitions/simpleTypes" }, - "minItems": 1, - "uniqueItems": true - } - ] - }, - "format": { "type": "string" }, - "contentMediaType": { "type": "string" }, - "contentEncoding": { "type": "string" }, - "if": { "$ref": "#" }, - "then": { "$ref": "#" }, - "else": { "$ref": "#" }, - "allOf": { "$ref": "#/definitions/schemaArray" }, - "anyOf": { "$ref": "#/definitions/schemaArray" }, - "oneOf": { "$ref": "#/definitions/schemaArray" }, - "not": { "$ref": "#" } - }, - "default": true -} diff --git a/test/blackbox/docs/JsonSchemaDraft-7/dummy.json b/test/blackbox/docs/JsonSchemaDraft-7/dummy.json deleted file mode 100644 index 70ddcadd32..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/dummy.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "type": "object", - "required": [ - "prop2" - ], - "x-schema-extensions-as-object": { - "type": "object", - "properties": { - "prop1": { - "type": "string" - }, - "prop2": { - "type": "integer", - "minimum": 0 - } - } - }, - "x-schema-extensions-as-primitive": "dummy", - "x-schema-extensions-as-array": [ - "item1", - "item2" - ], - "properties": { - "prop1": { - "type": "integer", - "minimum": 0, - "description": "Dummy prop1", - "x-prop1-dummy": "dummy extension" - }, - "prop2": { - "type": "string", - "description": "Dummy prop2" - }, - "sentAt": { - "$ref": "#/definitions/sentAt" - }, - "dummyArrayWithObject": { - "$ref": "#/definitions/dummyArrayWithObject" - }, - "dummyArrayWithArray": { - "$ref": "#/definitions/dummyArrayWithArray" - }, - "dummyArrayWithArrayNoAdditionalItems": { - "$ref": "#/definitions/dummyArrayWithArrayNoAdditionalItems" - }, - "dummyObject": { - "$ref": "#/definitions/dummyObject" - } - }, - "patternProperties": { - "^S(.?*)pattern&": { - "type": "string" - } - }, - "definitions": { - "dummyInfo": { - "type": "object", - "required": [ - "prop1" - ], - "properties": { - "prop1": { - "type": "string", - "enum": [ - "option1", - "option2" - ], - "description": "Dummy prop1" - }, - "sentAt": { - "$ref": "#/definitions/sentAt" - } - } - }, - "dummyArrayWithObject": { - "type": "array", - "items": { - "$ref": "#/definitions/dummyInfo" - } - }, - "dummyArrayWithArray": { - "type": "array", - "items": [ - { - "$ref": "#/definitions/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ], - "additionalItems": true - }, - "dummyArrayWithArrayNoAdditionalItems": { - "type": "array", - "items": [ - { - "$ref": "#/definitions/dummyInfo" - }, - { - "type": "string" - }, - { - "type": "number" - } - ], - "additionalItems": false - }, - "dummyObject": { - "type": "object", - "properties": { - "dummyObjectProp1": { - "$ref": "#/definitions/sentAt" - }, - "dummyObjectProp2": { - "$ref": "#/definitions/dummyRecursiveObject" - }, - "dummyObjectProp3": { - "type": "object", - "additionalProperties": true - }, - "dummyObjectProp4": { - "type": "object", - "additionalProperties": false - } - } - }, - "dummyRecursiveObject": { - "type": "object", - "properties": { - "dummyRecursiveProp1": { - "$ref": "#/definitions/dummyObject" - }, - "dummyRecursiveProp2": { - "type": "string" - } - } - }, - "sentAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the message was sent." - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/github-action.json b/test/blackbox/docs/JsonSchemaDraft-7/github-action.json deleted file mode 100644 index aa743c4c5f..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/github-action.json +++ /dev/null @@ -1,656 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema", - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions", - "definitions": { - "pre-if": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre-if", - "description": "Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.", - "type": "string" - }, - "post-if": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post-if", - "description": "Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.", - "type": "string" - }, - "runs-javascript": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions", - "description": "Configures the path to the action's code and the application used to execute the code.", - "type": "object", - "properties": { - "using": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing", - "description": "The application used to execute the code specified in `main`.", - "const": "node12" - }, - "main": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsmain", - "description": "The file that contains your action code. The application specified in `using` executes this file.", - "type": "string" - }, - "pre": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre", - "description": "Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.", - "type": "string" - }, - "pre-if": { - "$ref": "#/definitions/pre-if" - }, - "post": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post", - "description": "Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`.", - "type": "string" - }, - "post-if": { - "$ref": "#/definitions/post-if" - } - }, - "required": [ - "using", - "main" - ], - "additionalProperties": false - }, - "runs-composite": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-composite-run-steps-actions", - "description": "Configures the path to the composite action, and the application used to execute the code.", - "type": "object", - "properties": { - "using": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing-1", - "description": "To use a composite run steps action, set this to 'composite'.", - "const": "composite" - }, - "steps": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runssteps", - "description": "The run steps that you plan to run in this action.", - "type": "array", - "items": { - "type": "object", - "properties": { - "run": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsrun", - "description": "The command you want to run. This can be inline or a script in your action repository.", - "type": "string" - }, - "shell": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsshell", - "description": "The shell where you want to run the command.", - "type": "string", - "anyOf": [ - { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#custom-shell" - }, - { - "enum": [ - "bash", - "pwsh", - "python", - "sh", - "cmd", - "powershell" - ] - } - ] - }, - "uses": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsuses", - "description": "Selects an action to run as part of a step in your job.", - "type": "string" - }, - "with": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepswith", - "description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.", - "type": "object" - }, - "name": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsname", - "description": "The name of the composite run step.", - "type": "string" - }, - "id": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsid", - "description": "A unique identifier for the step. You can use the `id` to reference the step in contexts.", - "type": "string" - }, - "env": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsenv", - "description": "Sets a map of environment variables for only that step.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "working-directory": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsworking-directory", - "description": "Specifies the working directory where the command is run.", - "type": "string" - } - }, - "oneOf": [ - { - "required": [ - "run", - "shell" - ] - }, - { - "required": [ - "uses" - ] - } - ], - "additionalProperties": false - } - } - }, - "required": [ - "using", - "steps" - ], - "additionalProperties": false - }, - "runs-docker": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-docker-actions", - "description": "Configures the image used for the Docker action.", - "type": "object", - "properties": { - "using": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing-2", - "description": "You must set this value to 'docker'.", - "const": "docker" - }, - "image": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsimage", - "description": "The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.", - "type": "string" - }, - "env": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsenv", - "description": "Specifies a key/value map of environment variables to set in the container environment.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "entrypoint": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsentrypoint", - "description": "Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction.", - "type": "string" - }, - "pre-entrypoint": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre-entrypoint", - "description": "Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`.", - "type": "string" - }, - "pre-if": { - "$ref": "#/definitions/pre-if" - }, - "post-entrypoint": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post-entrypoint", - "description": "Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`.", - "type": "string" - }, - "post-if": { - "$ref": "#/definitions/post-if" - }, - "args": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsargs", - "description": "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "using", - "image" - ], - "additionalProperties": false - }, - "outputs": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs", - "description": "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.", - "type": "object", - "patternProperties": { - "^[_a-zA-Z][a-zA-Z0-9_-]*$": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id", - "description": "A string identifier to associate with the output. The value of `` is a map of the output's metadata. The `` must be a unique identifier within the outputs object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", - "type": "object", - "properties": { - "description": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_iddescription", - "description": "A string description of the output parameter.", - "type": "string" - } - }, - "required": [ - "description" - ], - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "outputs-composite": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions", - "description": "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.", - "type": "object", - "patternProperties": { - "^[_a-zA-Z][a-zA-Z0-9_-]*$": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id", - "description": "A string identifier to associate with the output. The value of `` is a map of the output's metadata. The `` must be a unique identifier within the outputs object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", - "type": "object", - "properties": { - "description": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_iddescription", - "description": "A string description of the output parameter.", - "type": "string" - }, - "value": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_idvalue", - "description": "The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.", - "type": "string" - } - }, - "required": [ - "description", - "value" - ], - "additionalProperties": false - } - }, - "additionalProperties": false - } - }, - "properties": { - "name": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#name", - "description": "The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.", - "type": "string" - }, - "author": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#author", - "description": "The name of the action's author.", - "type": "string" - }, - "description": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#description", - "description": "A short description of the action.", - "type": "string" - }, - "inputs": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs", - "description": "Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.", - "type": "object", - "patternProperties": { - "^[_a-zA-Z][a-zA-Z0-9_-]*$": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_id", - "description": "A string identifier to associate with the input. The value of `` is a map of the input's metadata. The `` must be a unique identifier within the inputs object. The `` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", - "type": "object", - "properties": { - "description": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddescription", - "description": "A string description of the input parameter.", - "type": "string" - }, - "deprecationMessage": { - "description": "A string shown to users using the deprecated input.", - "type": "string" - }, - "required": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_idrequired", - "description": "A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.", - "type": "boolean" - }, - "default": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddefault", - "description": "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.", - "type": "string" - } - }, - "required": [ - "description", - "required" - ], - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "outputs": { - "$comment": "Because of `additionalProperties: false`, this empty schema is needed to allow the `outputs` property. The `outputs` subschema is determined by the if/then/else keywords." - }, - "runs": { - "oneOf": [ - { - "$ref": "#/definitions/runs-javascript" - }, - { - "$ref": "#/definitions/runs-composite" - }, - { - "$ref": "#/definitions/runs-docker" - } - ] - }, - "branding": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#branding", - "description": "You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.", - "type": "object", - "properties": { - "color": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingcolor", - "description": "The background color of the badge.", - "type": "string", - "enum": [ - "white", - "yellow", - "blue", - "green", - "orange", - "red", - "purple", - "gray-dark" - ] - }, - "icon": { - "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingicon", - "description": "The name of the Feather icon to use.", - "type": "string", - "enum": [ - "activity", - "airplay", - "alert-circle", - "alert-octagon", - "alert-triangle", - "align-center", - "align-justify", - "align-left", - "align-right", - "anchor", - "aperture", - "archive", - "arrow-down-circle", - "arrow-down-left", - "arrow-down-right", - "arrow-down", - "arrow-left-circle", - "arrow-left", - "arrow-right-circle", - "arrow-right", - "arrow-up-circle", - "arrow-up-left", - "arrow-up-right", - "arrow-up", - "at-sign", - "award", - "bar-chart-2", - "bar-chart", - "battery-charging", - "battery", - "bell-off", - "bell", - "bluetooth", - "bold", - "book-open", - "book", - "bookmark", - "box", - "briefcase", - "calendar", - "camera-off", - "camera", - "cast", - "check-circle", - "check-square", - "check", - "chevron-down", - "chevron-left", - "chevron-right", - "chevron-up", - "chevrons-down", - "chevrons-left", - "chevrons-right", - "chevrons-up", - "circle", - "clipboard", - "clock", - "cloud-drizzle", - "cloud-lightning", - "cloud-off", - "cloud-rain", - "cloud-snow", - "cloud", - "code", - "command", - "compass", - "copy", - "corner-down-left", - "corner-down-right", - "corner-left-down", - "corner-left-up", - "corner-right-down", - "corner-right-up", - "corner-up-left", - "corner-up-right", - "cpu", - "credit-card", - "crop", - "crosshair", - "database", - "delete", - "disc", - "dollar-sign", - "download-cloud", - "download", - "droplet", - "edit-2", - "edit-3", - "edit", - "external-link", - "eye-off", - "eye", - "facebook", - "fast-forward", - "feather", - "file-minus", - "file-plus", - "file-text", - "file", - "film", - "filter", - "flag", - "folder-minus", - "folder-plus", - "folder", - "gift", - "git-branch", - "git-commit", - "git-merge", - "git-pull-request", - "globe", - "grid", - "hard-drive", - "hash", - "headphones", - "heart", - "help-circle", - "home", - "image", - "inbox", - "info", - "italic", - "layers", - "layout", - "life-buoy", - "link-2", - "link", - "list", - "loader", - "lock", - "log-in", - "log-out", - "mail", - "map-pin", - "map", - "maximize-2", - "maximize", - "menu", - "message-circle", - "message-square", - "mic-off", - "mic", - "minimize-2", - "minimize", - "minus-circle", - "minus-square", - "minus", - "monitor", - "moon", - "more-horizontal", - "more-vertical", - "move", - "music", - "navigation-2", - "navigation", - "octagon", - "package", - "paperclip", - "pause-circle", - "pause", - "percent", - "phone-call", - "phone-forwarded", - "phone-incoming", - "phone-missed", - "phone-off", - "phone-outgoing", - "phone", - "pie-chart", - "play-circle", - "play", - "plus-circle", - "plus-square", - "plus", - "pocket", - "power", - "printer", - "radio", - "refresh-ccw", - "refresh-cw", - "repeat", - "rewind", - "rotate-ccw", - "rotate-cw", - "rss", - "save", - "scissors", - "search", - "send", - "server", - "settings", - "share-2", - "share", - "shield-off", - "shield", - "shopping-bag", - "shopping-cart", - "shuffle", - "sidebar", - "skip-back", - "skip-forward", - "slash", - "sliders", - "smartphone", - "speaker", - "square", - "star", - "stop-circle", - "sun", - "sunrise", - "sunset", - "tablet", - "tag", - "target", - "terminal", - "thermometer", - "thumbs-down", - "thumbs-up", - "toggle-left", - "toggle-right", - "trash-2", - "trash", - "trending-down", - "trending-up", - "triangle", - "truck", - "tv", - "type", - "umbrella", - "underline", - "unlock", - "upload-cloud", - "upload", - "user-check", - "user-minus", - "user-plus", - "user-x", - "user", - "users", - "video-off", - "video", - "voicemail", - "volume-1", - "volume-2", - "volume-x", - "volume", - "watch", - "wifi-off", - "wifi", - "wind", - "x-circle", - "x-square", - "x", - "zap-off", - "zap", - "zoom-in", - "zoom-out" - ] - } - }, - "additionalProperties": false - } - }, - "if": { - "properties": { - "runs": { - "properties": { - "using": { - "const": "composite" - } - } - } - } - }, - "then": { - "properties": { - "outputs": { - "$ref": "#/definitions/outputs-composite" - } - } - }, - "else": { - "properties": { - "outputs": { - "$ref": "#/definitions/outputs" - } - } - }, - "required": [ - "name", - "description", - "runs" - ], - "additionalProperties": false -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/github-workflow.json b/test/blackbox/docs/JsonSchemaDraft-7/github-workflow.json deleted file mode 100644 index 35cf4542c5..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/github-workflow.json +++ /dev/null @@ -1,1533 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema", - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions", - "definitions": { - "architecture": { - "type": "string", - "enum": [ - "ARM32", - "x64", - "x86" - ] - }, - "branch": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestbranchestags", - "$ref": "#/definitions/globs", - "description": "When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.\nThe branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nThe patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.\nYou can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:\n- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.\n- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.\nYou can exclude tags and branches using the ! character. The order that you define patterns matters.\n- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.\n- A matching positive pattern after a negative match will include the Git ref again." - }, - "concurrency": { - "type": "object", - "properties": { - "group": { - "$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1", - "description": "When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.", - "type": "string" - }, - "cancel-in-progress": { - "$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-using-concurrency-to-cancel-any-in-progress-job-or-run-1", - "description": "To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.", - "type": "boolean" - } - }, - "required": [ - "group" - ], - "additionalProperties": false - }, - "configuration": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/configuration" - } - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/configuration" - } - } - ] - }, - "container": { - "type": "object", - "properties": { - "image": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerimage", - "description": "The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.", - "type": "string" - }, - "credentials": { - "$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainercredentials", - "description": "If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.", - "type": "object", - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - } - }, - "env": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerenv", - "$ref": "#/definitions/env", - "description": "Sets an array of environment variables in the container." - }, - "ports": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainerports", - "description": "Sets an array of ports to expose on the container.", - "type": "array", - "items": { - "oneOf": [ - { - "type": "number" - }, - { - "type": "string" - } - ] - }, - "minItems": 1 - }, - "volumes": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainervolumes", - "description": "Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.\nTo specify a volume, you specify the source and destination path: :\nThe is a volume name or an absolute path on the host machine, and is an absolute path in the container.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[^:]+:[^:]+$" - }, - "minItems": 1 - }, - "options": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontaineroptions", - "description": "Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.", - "type": "string" - } - }, - "required": [ - "image" - ], - "additionalProperties": false - }, - "defaults": { - "type": "object", - "properties": { - "run": { - "type": "object", - "properties": { - "shell": { - "$ref": "#/definitions/shell" - }, - "working-directory": { - "$ref": "#/definitions/working-directory" - } - }, - "minProperties": 1, - "additionalProperties": false - } - }, - "minProperties": 1, - "additionalProperties": false - }, - "permissions": { - "$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions", - "description": "You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.", - "oneOf": [ - { - "type": "string", - "enum": [ - "read-all", - "write-all" - ] - }, - { - "$ref": "#/definitions/permissions-event" - } - ] - }, - "permissions-event": { - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "actions": { - "$ref": "#/definitions/permissions-level" - }, - "checks": { - "$ref": "#/definitions/permissions-level" - }, - "contents": { - "$ref": "#/definitions/permissions-level" - }, - "deployments": { - "$ref": "#/definitions/permissions-level" - }, - "issues": { - "$ref": "#/definitions/permissions-level" - }, - "packages": { - "$ref": "#/definitions/permissions-level" - }, - "pull-requests": { - "$ref": "#/definitions/permissions-level" - }, - "repository-projects": { - "$ref": "#/definitions/permissions-level" - }, - "security-events": { - "$ref": "#/definitions/permissions-level" - }, - "statuses": { - "$ref": "#/definitions/permissions-level" - } - } - }, - "permissions-level": { - "type": "string", - "enum": [ - "read", - "write", - "none" - ] - }, - "env": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ] - }, - "minProperties": 1 - }, - "environment": { - "$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment", - "description": "The environment that the job references", - "type": "object", - "properties": { - "name": { - "$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-a-single-environment-name", - "description": "The name of the environment configured in the repo.", - "type": "string" - }, - "url": { - "$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-using-environment-name-and-url", - "description": "A deployment URL", - "type": "string" - } - }, - "required": [ - "name" - ], - "additionalProperties": false - }, - "event": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows", - "type": "string", - "enum": [ - "check_run", - "check_suite", - "create", - "delete", - "deployment", - "deployment_status", - "discussion", - "discussion_comment", - "fork", - "gollum", - "issue_comment", - "issues", - "label", - "member", - "milestone", - "page_build", - "project", - "project_card", - "project_column", - "public", - "pull_request", - "pull_request_review", - "pull_request_review_comment", - "pull_request_target", - "push", - "registry_package", - "release", - "status", - "watch", - "workflow_dispatch", - "workflow_run", - "repository_dispatch" - ] - }, - "eventObject": { - "oneOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ], - "additionalProperties": true - }, - "expressionSyntax": { - "type": "string", - "pattern": "^\\$\\{\\{.*\\}\\}$" - }, - "globs": { - "type": "array", - "items": { - "type": "string", - "minLength": 1 - }, - "minItems": 1 - }, - "machine": { - "type": "string", - "enum": [ - "linux", - "macos", - "windows" - ] - }, - "name": { - "type": "string", - "pattern": "^[_a-zA-Z][a-zA-Z0-9_-]*$" - }, - "path": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths", - "$ref": "#/definitions/globs", - "description": "When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.\nThe paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.\nYou can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.\n- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.\n- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths." - }, - "ref": { - "properties": { - "branches": { - "$ref": "#/definitions/branch" - }, - "branches-ignore": { - "$ref": "#/definitions/branch" - }, - "tags": { - "$ref": "#/definitions/branch" - }, - "tags-ignore": { - "$ref": "#/definitions/branch" - }, - "paths": { - "$ref": "#/definitions/path" - }, - "paths-ignore": { - "$ref": "#/definitions/path" - } - }, - "oneOf": [ - { - "type": "object", - "allOf": [ - { - "not": { - "required": [ - "branches", - "branches-ignore" - ] - } - }, - { - "not": { - "required": [ - "tags", - "tags-ignore" - ] - } - }, - { - "not": { - "required": [ - "paths", - "paths-ignore" - ] - } - } - ] - }, - { - "type": "null" - } - ] - }, - "shell": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell", - "description": "You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.", - "type": "string", - "anyOf": [ - { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#custom-shell" - }, - { - "enum": [ - "bash", - "pwsh", - "python", - "sh", - "cmd", - "powershell" - ] - } - ] - }, - "types": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onevent_nametypes", - "description": "Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.\nYou can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.", - "type": "array", - "minItems": 1 - }, - "working-directory": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun", - "description": "Using the working-directory keyword, you can specify the working directory of where to run the command.", - "type": "string" - } - }, - "properties": { - "name": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#name", - "description": "The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.", - "type": "string" - }, - "on": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#on", - "description": "The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.", - "oneOf": [ - { - "$ref": "#/definitions/event" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/event" - }, - "minItems": 1 - }, - { - "type": "object", - "properties": { - "check_run": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-run-event-check_run", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "rerequested", - "completed", - "requested_action" - ] - }, - "default": [ - "created", - "rerequested", - "completed", - "requested_action" - ] - } - } - }, - "check_suite": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#check-suite-event-check_suite", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "completed", - "requested", - "rerequested" - ] - }, - "default": [ - "completed", - "requested", - "rerequested" - ] - } - } - }, - "create": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#create-event-create", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference." - }, - "delete": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#delete-event-delete", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference." - }, - "deployment": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#deployment-event-deployment", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/." - }, - "deployment_status": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#deployment-status-event-deployment_status", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status." - }, - "discussion": { - "$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "opened", - "edited", - "deleted", - "transferred", - "pinned", - "unpinned", - "labeled", - "unlabeled", - "locked", - "unlocked", - "category_changed", - "answered", - "unanswered" - ] - }, - "default": [ - "opened", - "edited", - "deleted", - "transferred", - "pinned", - "unpinned", - "labeled", - "unlabeled", - "locked", - "unlocked", - "category_changed", - "answered", - "unanswered" - ] - } - } - }, - "discussion_comment": { - "$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#discussion_comment", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "edited", - "deleted" - ] - } - } - }, - "fork": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#fork-event-fork", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork." - }, - "gollum": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#gollum-event-gollum", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event." - }, - "issue_comment": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#issue-comment-event-issue_comment", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "edited", - "deleted" - ] - } - } - }, - "issues": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#issues-event-issues", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "opened", - "edited", - "deleted", - "transferred", - "pinned", - "unpinned", - "closed", - "reopened", - "assigned", - "unassigned", - "labeled", - "unlabeled", - "locked", - "unlocked", - "milestoned", - "demilestoned" - ] - }, - "default": [ - "opened", - "edited", - "deleted", - "transferred", - "pinned", - "unpinned", - "closed", - "reopened", - "assigned", - "unassigned", - "labeled", - "unlabeled", - "locked", - "unlocked", - "milestoned", - "demilestoned" - ] - } - } - }, - "label": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#label-event-label", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/labels/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "edited", - "deleted" - ] - } - } - }, - "member": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#member-event-member", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the member event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/collaborators/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "added", - "edited", - "deleted" - ] - }, - "default": [ - "added", - "edited", - "deleted" - ] - } - } - }, - "milestone": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#milestone-event-milestone", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/milestones/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "closed", - "opened", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "closed", - "opened", - "edited", - "deleted" - ] - } - } - }, - "page_build": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#page-build-event-page_build", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/." - }, - "project": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-event-project", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "updated", - "closed", - "reopened", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "updated", - "closed", - "reopened", - "edited", - "deleted" - ] - } - } - }, - "project_card": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-card-event-project_card", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "moved", - "converted", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "moved", - "converted", - "edited", - "deleted" - ] - } - } - }, - "project_column": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#project-column-event-project_column", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "updated", - "moved", - "deleted" - ] - }, - "default": [ - "created", - "updated", - "moved", - "deleted" - ] - } - } - }, - "public": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#public-event-public", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit." - }, - "pull_request": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-event-pull_request", - "$ref": "#/definitions/ref", - "description": "Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "assigned", - "unassigned", - "labeled", - "unlabeled", - "opened", - "edited", - "closed", - "reopened", - "synchronize", - "converted_to_draft", - "ready_for_review", - "locked", - "unlocked", - "review_requested", - "review_request_removed" - ] - }, - "default": [ - "opened", - "synchronize", - "reopened" - ] - } - }, - "patternProperties": { - "^(branche|tag|path)s(-ignore)?$": { - "type": "array" - } - }, - "additionalProperties": false - }, - "pull_request_review": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-review-event-pull_request_review", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "submitted", - "edited", - "dismissed" - ] - }, - "default": [ - "submitted", - "edited", - "dismissed" - ] - } - } - }, - "pull_request_review_comment": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-review-comment-event-pull_request_review_comment", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/comments.\nNote: Workflows do not run on private base repositories when you open a pull request from a forked repository.\nWhen you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.\nWorkflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.\nThe permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "created", - "edited", - "deleted" - ] - }, - "default": [ - "created", - "edited", - "deleted" - ] - } - } - }, - "pull_request_target": { - "$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target", - "$ref": "#/definitions/ref", - "description": "This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit. This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "assigned", - "unassigned", - "labeled", - "unlabeled", - "opened", - "edited", - "closed", - "reopened", - "synchronize", - "ready_for_review", - "locked", - "unlocked", - "review_requested", - "review_request_removed" - ] - }, - "default": [ - "opened", - "synchronize", - "reopened" - ] - } - }, - "patternProperties": { - "^(branche|tag|path)s(-ignore)?$": {} - }, - "additionalProperties": false - }, - "push": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#push-event-push", - "$ref": "#/definitions/ref", - "description": "Runs your workflow when someone pushes to a repository branch, which triggers the push event.\nNote: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit.", - "patternProperties": { - "^(branche|tag|path)s(-ignore)?$": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "additionalProperties": false - }, - "registry_package": { - "$comment": "https://help.github.com/en/actions/reference/events-that-trigger-workflows#registry-package-event-registry_package", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime a package is published or updated. For more information, see https://help.github.com/en/github/managing-packages-with-github-packages.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "published", - "updated" - ] - }, - "default": [ - "published", - "updated" - ] - } - } - }, - "release": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#release-event-release", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "published", - "unpublished", - "created", - "edited", - "deleted", - "prereleased", - "released" - ] - }, - "default": [ - "published", - "unpublished", - "created", - "edited", - "deleted", - "prereleased", - "released" - ] - } - } - }, - "status": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#status-event-status", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/." - }, - "watch": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#watch-event-watch", - "$ref": "#/definitions/eventObject", - "description": "Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/." - }, - "workflow_dispatch": { - "$comment": "https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/", - "description": "You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.", - "properties": { - "inputs": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs", - "description": "Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.", - "type": "object", - "patternProperties": { - "^[_a-zA-Z][a-zA-Z0-9_-]*$": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_id", - "description": "A string identifier to associate with the input. The value of is a map of the input's metadata. The must be a unique identifier within the inputs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _.", - "type": "object", - "properties": { - "description": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddescription", - "description": "A string description of the input parameter.", - "type": "string" - }, - "deprecationMessage": { - "description": "A string shown to users using the deprecated input.", - "type": "string" - }, - "required": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_idrequired", - "description": "A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required.", - "type": "boolean" - }, - "default": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputsinput_iddefault", - "description": "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.", - "type": "string" - } - }, - "required": [ - "description", - "required" - ], - "additionalProperties": false - } - }, - "additionalProperties": false - } - } - }, - "workflow_run": { - "$comment": "https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run", - "$ref": "#/definitions/eventObject", - "description": "This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.", - "properties": { - "types": { - "$ref": "#/definitions/types", - "items": { - "type": "string", - "enum": [ - "requested", - "completed" - ] - }, - "default": [ - "requested", - "completed" - ] - }, - "workflows": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "patternProperties": { - "^branches(-ignore)?$": {} - } - }, - "repository_dispatch": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#external-events-repository_dispatch", - "$ref": "#/definitions/eventObject", - "description": "You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event.\nTo trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event." - }, - "schedule": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events-schedule", - "description": "You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.\nNote: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.\nYou can use crontab guru (https://crontab.guru/). to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html).", - "type": "array", - "items": { - "properties": { - "cron": { - "$comment": "https://stackoverflow.com/a/57639657/4044345", - "type": "string", - "pattern": "^(((\\d+,)+\\d+|((\\d+|\\*)\\/\\d+|((JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(-(JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?))|(\\d+-\\d+)|\\d+|\\*|((MON|TUE|WED|THU|FRI|SAT|SUN)(-(MON|TUE|WED|THU|FRI|SAT|SUN))?)) ?){5,7}$" - } - }, - "additionalProperties": false - }, - "minItems": 1 - } - }, - "additionalProperties": false - } - ] - }, - "env": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env", - "$ref": "#/definitions/env", - "description": "A map of environment variables that are available to all jobs and steps in the workflow." - }, - "defaults": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#defaults", - "$ref": "#/definitions/defaults", - "description": "A map of default settings that will apply to all jobs in the workflow." - }, - "concurrency": { - "$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency", - "description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.", - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/definitions/concurrency" - } - ] - }, - "jobs": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobs", - "description": "A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs..needs keyword.\nEach job runs in a fresh instance of the virtual environment specified by runs-on.\nYou can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#usage-limits.", - "type": "object", - "patternProperties": { - "^[_a-zA-Z][a-zA-Z0-9_-]*$": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_id", - "description": "Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace with a string that is unique to the jobs object. The must start with a letter or _ and contain only alphanumeric characters, -, or _.", - "type": "object", - "properties": { - "name": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname", - "description": "The name of the job displayed on GitHub.", - "type": "string" - }, - "needs": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idneeds", - "description": "Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.", - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/name" - }, - "minItems": 1 - }, - { - "$ref": "#/definitions/name" - } - ] - }, - "permissions": { - "$ref": "#/definitions/permissions-event" - }, - "runs-on": { - "$comment": "https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on", - "description": "The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.", - "oneOf": [ - { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#github-hosted-runners", - "type": "string", - "enum": [ - "macos-10.15", - "macos-11", - "macos-latest", - "self-hosted", - "ubuntu-18.04", - "ubuntu-20.04", - "ubuntu-latest", - "windows-2016", - "windows-2019", - "windows-2022", - "windows-latest" - ] - }, - { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#self-hosted-runners", - "type": "array", - "anyOf": [ - { - "items": [ - { - "const": "self-hosted" - } - ], - "minItems": 1, - "additionalProperties": { - "type": "string" - } - }, - { - "items": [ - { - "const": "self-hosted" - }, - { - "$ref": "#/definitions/machine" - } - ], - "minItems": 2, - "additionalProperties": { - "type": "string" - } - }, - { - "items": [ - { - "const": "self-hosted" - }, - { - "$ref": "#/definitions/architecture" - } - ], - "minItems": 2, - "additionalProperties": { - "type": "string" - } - }, - { - "items": [ - { - "const": "self-hosted" - }, - { - "$ref": "#/definitions/machine" - }, - { - "$ref": "#/definitions/architecture" - } - ], - "minItems": 3, - "additionalProperties": { - "type": "string" - } - }, - { - "items": [ - { - "const": "self-hosted" - }, - { - "$ref": "#/definitions/architecture" - }, - { - "$ref": "#/definitions/machine" - } - ], - "minItems": 3, - "additionalProperties": { - "type": "string" - } - } - ] - }, - { - "$ref": "#/definitions/expressionSyntax" - } - ] - }, - "environment": { - "$comment": "https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idenvironment", - "description": "The environment that the job references.", - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/definitions/environment" - } - ] - }, - "outputs": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjobs_idoutputs", - "description": "A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "minProperties": 1 - }, - "env": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idenv", - "$ref": "#/definitions/env", - "description": "A map of environment variables that are available to all steps in the job." - }, - "defaults": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_iddefaults", - "$ref": "#/definitions/defaults", - "description": "A map of default settings that will apply to all steps in the job." - }, - "if": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif", - "description": "You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.", - "type": "string" - }, - "steps": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idsteps", - "description": "A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid", - "description": "A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.", - "type": "string" - }, - "if": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsif", - "description": "You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.", - "type": "string" - }, - "name": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsname", - "description": "A name for your step to display on GitHub.", - "type": "string" - }, - "uses": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsuses", - "description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/).\nWe strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.\n- Using the commit SHA of a released action version is the safest for stability and security.\n- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.\n- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.\nSome actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.\nActions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions.", - "type": "string" - }, - "run": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsrun", - "description": "Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.\nCommands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.\nEach run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.", - "type": "string" - }, - "working-directory": { - "$ref": "#/definitions/working-directory" - }, - "shell": { - "$ref": "#/definitions/shell" - }, - "with": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswith", - "$ref": "#/definitions/env", - "description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.", - "properties": { - "args": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithargs", - "type": "string" - }, - "entrypoint": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithentrypoint", - "type": "string" - } - } - }, - "env": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv", - "$ref": "#/definitions/env", - "description": "Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job." - }, - "continue-on-error": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error", - "description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.", - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/definitions/expressionSyntax" - } - ], - "default": false - }, - "timeout-minutes": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepstimeout-minutes", - "description": "The maximum number of minutes to run the step before killing the process.", - "type": "number" - } - }, - "dependencies": { - "working-directory": [ - "run" - ], - "shell": [ - "run" - ] - }, - "additionalProperties": false - }, - "minItems": 1 - }, - "timeout-minutes": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes", - "description": "The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360", - "type": "number", - "default": 360 - }, - "strategy": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategy", - "description": "A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.", - "type": "object", - "properties": { - "matrix": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix", - "description": "A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.\nYou can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.\nWhen you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.", - "oneOf": [ - { - "type": "object" - }, - { - "$ref": "#/definitions/expressionSyntax" - } - ], - "patternProperties": { - "^(in|ex)clude$": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#example-including-configurations-in-a-matrix-build", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/configuration" - } - }, - "minItems": 1 - } - }, - "additionalProperties": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/configuration" - }, - "minItems": 1 - }, - { - "$ref": "#/definitions/expressionSyntax" - } - ] - }, - "minProperties": 1 - }, - "fail-fast": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast", - "description": "When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true", - "type": "boolean", - "default": true - }, - "max-parallel": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel", - "description": "The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.", - "type": "number" - } - }, - "required": [ - "matrix" - ], - "additionalProperties": false - }, - "continue-on-error": { - "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error", - "description": "Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.", - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/definitions/expressionSyntax" - } - ] - }, - "container": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idcontainer", - "description": "A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.\nIf you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.", - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/definitions/container" - } - ] - }, - "services": { - "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idservices", - "description": "Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.\nWhen you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.\nWhen both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.\nWhen a step does not use a container action, you must access the service using localhost and bind the ports.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/container" - } - }, - "concurrency": { - "$comment": "https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency", - "description": "Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. \nYou can also specify concurrency at the workflow level. \nWhen a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.", - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/definitions/concurrency" - } - ] - } - }, - "required": [ - "runs-on" - ], - "additionalProperties": false - } - }, - "minProperties": 1, - "additionalProperties": false - }, - "permissions": { - "$ref": "#/definitions/permissions" - } - }, - "required": [ - "on", - "jobs" - ], - "additionalProperties": false -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/gitlab-ci.json b/test/blackbox/docs/JsonSchemaDraft-7/gitlab-ci.json deleted file mode 100644 index e9eb336e36..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/gitlab-ci.json +++ /dev/null @@ -1,1649 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://gitlab.com/.gitlab-ci.yml", - "title": "Gitlab CI configuration", - "description": "Gitlab has a built-in solution for doing CI called Gitlab CI. It is configured by supplying a file called `.gitlab-ci.yml`, which will list all the jobs that are going to run for the project. A full list of all options can be found at https://docs.gitlab.com/ee/ci/yaml/. You can read more about Gitlab CI at https://docs.gitlab.com/ee/ci/README.html.", - "type": "object", - "properties": { - "$schema": { - "type": "string", - "format": "uri" - }, - "image": { - "$ref": "#/definitions/image" - }, - "services": { - "$ref": "#/definitions/services" - }, - "before_script": { - "$ref": "#/definitions/before_script" - }, - "after_script": { - "$ref": "#/definitions/after_script" - }, - "variables": { - "$ref": "#/definitions/globalVariables" - }, - "cache": { - "$ref": "#/definitions/cache" - }, - "default": { - "type": "object", - "properties": { - "after_script": { - "$ref": "#/definitions/after_script" - }, - "artifacts": { - "$ref": "#/definitions/artifacts" - }, - "before_script": { - "$ref": "#/definitions/before_script" - }, - "cache": { - "$ref": "#/definitions/cache" - }, - "image": { - "$ref": "#/definitions/image" - }, - "interruptible": { - "$ref": "#/definitions/interruptible" - }, - "retry": { - "$ref": "#/definitions/retry" - }, - "services": { - "$ref": "#/definitions/services" - }, - "tags": { - "$ref": "#/definitions/tags" - }, - "timeout": { - "$ref": "#/definitions/timeout" - } - }, - "additionalProperties": false - }, - "stages": { - "type": "array", - "description": "Groups jobs into stages. All jobs in one stage must complete before next stage is executed. Defaults to ['build', 'test', 'deploy'].", - "default": [ - "build", - "test", - "deploy" - ], - "items": { - "type": "string" - }, - "uniqueItems": true, - "minItems": 1 - }, - "include": { - "description": "Can be `IncludeItem` or `IncludeItem[]`. Each `IncludeItem` will be a string, or an object with properties for the method if including external YAML file. The external content will be fetched, included and evaluated along the `.gitlab-ci.yml`.", - "oneOf": [ - { - "$ref": "#/definitions/include_item" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/include_item" - } - } - ] - }, - "pages": { - "$ref": "#/definitions/job", - "description": "A special job used to upload static sites to Gitlab pages. Requires a `public/` directory with `artifacts.path` pointing to it." - }, - "workflow": { - "type": "object", - "properties": { - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "if": { - "type": "string" - }, - "variables": { - "$ref": "#/definitions/variables" - }, - "when": { - "type": "string", - "enum": [ - "always", - "never" - ] - } - }, - "additionalProperties": false - } - } - } - } - }, - "patternProperties": { - "^[.]": { - "description": "Hidden keys.", - "anyOf": [ - { - "$ref": "#/definitions/job_template" - }, - { - "description": "Arbitrary YAML anchor." - } - ] - } - }, - "additionalProperties": { - "$ref": "#/definitions/job" - }, - "definitions": { - "artifacts": { - "type": "object", - "description": "Used to specify a list of files and directories that should be attached to the job if it succeeds. Artifacts are sent to Gitlab where they can be downloaded.", - "additionalProperties": false, - "properties": { - "paths": { - "type": "array", - "description": "A list of paths to files/folders that should be included in the artifact.", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "exclude": { - "type": "array", - "description": "A list of paths to files/folders that should be excluded in the artifact.", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "expose_as": { - "type": "string", - "description": "Can be used to expose job artifacts in the merge request UI. GitLab will add a link to the relevant merge request that points to the artifact." - }, - "name": { - "type": "string", - "description": "Name for the archive created on job success. Can use variables in the name, e.g. '$CI_JOB_NAME'" - }, - "untracked": { - "type": "boolean", - "description": "Whether to add all untracked files (along with 'artifacts.paths') to the artifact.", - "default": false - }, - "when": { - "description": "Configure when artifacts are uploaded depended on job status.", - "default": "on_success", - "oneOf": [ - { - "enum": [ - "on_success" - ], - "description": "Upload artifacts only when the job succeeds (this is the default)." - }, - { - "enum": [ - "on_failure" - ], - "description": "Upload artifacts only when the job fails." - }, - { - "enum": [ - "always" - ], - "description": "Upload artifacts regardless of job status." - } - ] - }, - "expire_in": { - "type": "string", - "description": "How long artifacts should be kept. They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.", - "default": "30 days" - }, - "reports": { - "type": "object", - "description": "Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.", - "additionalProperties": false, - "properties": { - "junit": { - "description": "Path for file(s) that should be parsed as JUnit XML result", - "oneOf": [ - { - "type": "string", - "description": "Path to a single XML file" - }, - { - "type": "array", - "description": "A list of paths to XML files that will automatically be concatenated into a single file", - "items": { - "type": "string" - }, - "minItems": 1 - } - ] - }, - "cobertura": { - "description": "Path for file(s) that should be parsed as Cobertura XML coverage report", - "oneOf": [ - { - "type": "string", - "description": "Path to a single XML file" - }, - { - "type": "array", - "description": "A list of paths to XML files that will automatically be merged into one report", - "items": { - "type": "string" - }, - "minItems": 1 - } - ] - }, - "codequality": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with code quality report(s) (such as Code Climate)." - }, - "dotenv": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files containing runtime-created variables for this job." - }, - "lsif": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files containing code intelligence (Language Server Index Format)." - }, - "sast": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with SAST vulnerabilities report(s)." - }, - "dependency_scanning": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with Dependency scanning vulnerabilities report(s)." - }, - "container_scanning": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with Container scanning vulnerabilities report(s)." - }, - "dast": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with DAST vulnerabilities report(s)." - }, - "license_management": { - "$ref": "#/definitions/string_file_list", - "description": "Deprecated in 12.8: Path to file or list of files with license report(s)." - }, - "license_scanning": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with license report(s)." - }, - "performance": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with performance metrics report(s)." - }, - "requirements": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with requirements report(s)." - }, - "secret_detection": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with secret detection report(s)." - }, - "metrics": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with custom metrics report(s)." - }, - "terraform": { - "$ref": "#/definitions/string_file_list", - "description": "Path to file or list of files with terraform plan(s)." - } - } - } - } - }, - "string_file_list": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "include_item": { - "oneOf": [ - { - "description": "Will infer the method based on the value. E.g. `https://...` strings will be of type `include:remote`, and `/templates/...` will be of type `include:local`.", - "type": "string", - "format": "uri-reference", - "pattern": "^(https?://|/).+\\.ya?ml$" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "local": { - "description": "Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - } - }, - "required": [ - "local" - ] - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "project": { - "description": "Path to the project, e.g. `group/project`, or `group/sub-group/project`.", - "type": "string", - "pattern": "\\S/\\S" - }, - "ref": { - "description": "Branch/Tag/Commit-hash for the target project.", - "type": "string" - }, - "file": { - "oneOf": [ - { - "description": "Relative path from project root (`/`) to the `yaml`/`yml` file template.", - "type": "string", - "pattern": "\\.ya?ml$" - }, - { - "description": "List of files by relative path from project root (`/`) to the `yaml`/`yml` file template.", - "type": "array", - "items": { - "type": "string", - "pattern": "\\.ya?ml$" - } - } - ] - } - }, - "required": [ - "project", - "file" - ] - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "template": { - "description": "Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - } - }, - "required": [ - "template" - ] - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "remote": { - "description": "URL to a `yaml`/`yml` template file using HTTP/HTTPS.", - "type": "string", - "format": "uri-reference", - "pattern": "^https?://.+\\.ya?ml$" - } - }, - "required": [ - "remote" - ] - } - ] - }, - "image": { - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "Full name of the image that should be used. It should contain the Registry part if needed." - }, - { - "type": "object", - "description": "Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor.", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "Full name of the image that should be used. It should contain the Registry part if needed." - }, - "entrypoint": { - "type": "array", - "description": "Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.", - "minItems": 1 - } - }, - "required": [ - "name" - ] - } - ], - "description": "Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor." - }, - "services": { - "type": "array", - "description": "Similar to `image` property, but will link the specified services to the `image` container.", - "items": { - "oneOf": [ - { - "type": "string", - "minLength": 1, - "description": "Full name of the image that should be used. It should contain the Registry part if needed." - }, - { - "type": "object", - "description": "", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "Full name of the image that should be used. It should contain the Registry part if needed.", - "minLength": 1 - }, - "entrypoint": { - "type": "array", - "description": "Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.", - "minItems": 1, - "items": { - "type": "string" - } - }, - "command": { - "type": "array", - "description": "Command or script that should be used as the container's command. It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array.", - "minItems": 1, - "items": { - "type": "string" - } - }, - "alias": { - "type": "string", - "description": "Additional alias that can be used to access the service from the job's container. Read Accessing the services for more information.", - "minLength": 1 - } - }, - "required": [ - "name" - ] - } - ] - } - }, - "secrets": { - "type": "object", - "description": "Defines secrets to be injected as environment variables", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Environment variable name", - "properties": { - "vault": { - "oneOf": [ - { - "type": "string", - "description": "The secret to be fetched from Vault (e.g. 'production/db/password@ops' translates to secret 'ops/data/production/db', field `password`)" - }, - { - "type": "object", - "properties": { - "engine": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "path": { - "type": "string" - } - }, - "required": [ - "name", - "path" - ] - }, - "path": { - "type": "string" - }, - "field": { - "type": "string" - } - }, - "required": [ - "engine", - "path", - "field" - ] - } - ] - } - }, - "required": [ - "vault" - ] - } - } - }, - "before_script": { - "type": "array", - "description": "Defines scripts that should run *before* the job. Can be set globally or per job.", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - "after_script": { - "type": "array", - "description": "Defines scripts that should run *after* the job. Can be set globally or per job.", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - "rules": { - "type": "array", - "description": "rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.", - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "if": { - "type": "string", - "description": "Expression to evaluate whether additional attributes should be provided to the job" - }, - "changes": { - "type": "array", - "description": "Additional attributes will be provided to job if any of the provided paths matches a modified file", - "items": { - "type": "string" - } - }, - "exists": { - "type": "array", - "description": "Additional attributes will be provided to job if any of the provided paths matches an existing file in the repository", - "items": { - "type": "string" - } - }, - "variables": { - "$ref": "#/definitions/variables" - }, - "when": { - "$ref": "#/definitions/when" - }, - "start_in": { - "$ref": "#/definitions/start_in" - }, - "allow_failure": { - "$ref": "#/definitions/allow_failure" - } - } - } - }, - "globalVariables": { - "description": "Defines environment variables globally. Job level property overrides global variables. If a job sets `variables: {}`, all global variables are turned off. You can use the value and description keywords to define variables that are prefilled when running a pipeline manually.", - "type": "object", - "additionalProperties": { - "anyOf": [ - { - "type": [ - "string", - "integer" - ] - }, - { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "description": { - "type": "string", - "description": "Explains what the variable is used for, what the acceptable values are." - } - } - } - ] - } - }, - "variables": { - "type": "object", - "description": "Defines environment variables for specific jobs. Job level property overrides global variables. If a job sets `variables: {}`, all global variables are turned off.", - "additionalProperties": { - "type": [ - "string", - "integer" - ] - } - }, - "timeout": { - "type": "string", - "description": "Allows you to configure a timeout for a specific job (e.g. `1 minute`, `1h 30m 12s`). Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#timeout", - "minLength": 1 - }, - "start_in": { - "type": "string", - "description": "Used in conjunction with 'when: delayed' to set how long to delay before starting a job.", - "minLength": 1 - }, - "allow_failure": { - "description": "Allow job to fail. A failed job does not cause the pipeline to fail.", - "oneOf": [ - { - "description": "Setting this option to true will allow the job to fail while still letting the pipeline pass.", - "type": "boolean", - "default": false - }, - { - "description": "Exit code that are not considered failure. The job fails for any other exit code.", - "type": "object", - "additionalProperties": false, - "required": [ - "exit_codes" - ], - "properties": { - "exit_codes": { - "type": "integer" - } - } - }, - { - "description": "You can list which exit codes are not considered failures. The job fails for any other exit code.", - "type": "object", - "additionalProperties": false, - "required": [ - "exit_codes" - ], - "properties": { - "exit_codes": { - "type": "array", - "minItems": 1, - "uniqueItems": true, - "items": { - "type": "integer" - } - } - } - } - ] - }, - "when": { - "description": "Describes the conditions for when to run the job. Defaults to 'on_success'.", - "default": "on_success", - "oneOf": [ - { - "enum": [ - "on_success" - ], - "description": "Execute job only when all jobs from prior stages succeed." - }, - { - "enum": [ - "on_failure" - ], - "description": "Execute job when at least one job from prior stages fails." - }, - { - "enum": [ - "always" - ], - "description": "Execute job regardless of the status from prior stages." - }, - { - "enum": [ - "manual" - ], - "description": "Execute the job manually from Gitlab UI or API. Read more: https://docs.gitlab.com/ee/ci/yaml/#when-manual" - }, - { - "enum": [ - "delayed" - ], - "description": "Execute a job after the time limit in 'start_in' expires. Read more: https://docs.gitlab.com/ee/ci/yaml/#when-delayed" - }, - { - "enum": [ - "never" - ], - "description": "Never execute the job." - } - ] - }, - "cache": { - "oneOf": [ - { - "$ref": "#/definitions/cache_entry" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/cache_entry" - } - } - ] - }, - "cache_entry": { - "type": "object", - "description": "Specify files or directories to cache between jobs. Can be set globally or per job.", - "additionalProperties": false, - "properties": { - "paths": { - "type": "array", - "description": "List of files or paths to cache.", - "items": { - "type": "string" - } - }, - "key": { - "oneOf": [ - { - "type": "string", - "description": "Unique cache ID, to allow e.g. specific branch or job cache. Environment variables can be used to set up unique keys (e.g. \"$CI_COMMIT_REF_SLUG\" for per branch cache)." - }, - { - "type": "object", - "description": "When you include cache:key:files, you must also list the project files that will be used to generate the key, up to a maximum of two files. The cache key will be a SHA checksum computed from the most recent commits (up to two, if two files are listed) that changed the given files.", - "properties": { - "files": { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1, - "maxItems": 2 - } - } - } - ] - }, - "untracked": { - "type": "boolean", - "description": "Set to `true` to cache untracked files.", - "default": false - }, - "policy": { - "type": "string", - "description": "Determines the strategy for downloading and updating the cache.", - "default": "pull-push", - "oneOf": [ - { - "enum": [ - "pull" - ], - "description": "Pull will download cache but skip uploading after job completes." - }, - { - "enum": [ - "push" - ], - "description": "Push will skip downloading cache and always recreate cache after job completes." - }, - { - "enum": [ - "pull-push" - ], - "description": "Pull-push will both download cache at job start and upload cache on job success." - } - ] - } - } - }, - "filter_refs": { - "type": "array", - "description": "Filter job by different keywords that determine origin or state, or by supplying string/regex to check against branch/tag names.", - "items": { - "anyOf": [ - { - "oneOf": [ - { - "enum": [ - "branches" - ], - "description": "When a branch is pushed." - }, - { - "enum": [ - "tags" - ], - "description": "When a tag is pushed." - }, - { - "enum": [ - "api" - ], - "description": "When a pipeline has been triggered by a second pipelines API (not triggers API)." - }, - { - "enum": [ - "external" - ], - "description": "When using CI services other than Gitlab" - }, - { - "enum": [ - "pipelines" - ], - "description": "For multi-project triggers, created using the API with 'CI_JOB_TOKEN'." - }, - { - "enum": [ - "pushes" - ], - "description": "Pipeline is triggered by a `git push` by the user" - }, - { - "enum": [ - "schedules" - ], - "description": "For scheduled pipelines." - }, - { - "enum": [ - "triggers" - ], - "description": "For pipelines created using a trigger token." - }, - { - "enum": [ - "web" - ], - "description": "For pipelines created using *Run pipeline* button in Gitlab UI (under your project's *Pipelines*)." - } - ] - }, - { - "type": "string", - "description": "String or regular expression to match against tag or branch names." - } - ] - } - }, - "filter": { - "oneOf": [ - { - "$ref": "#/definitions/filter_refs" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "refs": { - "$ref": "#/definitions/filter_refs" - }, - "kubernetes": { - "enum": [ - "active" - ], - "description": "Filter job based on if Kubernetes integration is active." - }, - "variables": { - "type": "array", - "description": "Filter job by checking comparing values of environment variables. Read more about variable expressions: https://docs.gitlab.com/ee/ci/variables/README.html#variables-expressions", - "items": { - "type": "string" - } - }, - "changes": { - "type": "array", - "description": "Filter job creation based on files that were modified in a git push.", - "items": { - "type": "string" - } - } - } - } - ] - }, - "retry": { - "description": "Retry a job if it fails. Can be a simple integer or object definition.", - "oneOf": [ - { - "$ref": "#/definitions/retry_max" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "max": { - "$ref": "#/definitions/retry_max" - }, - "when": { - "description": "Either a single or array of error types to trigger job retry.", - "oneOf": [ - { - "$ref": "#/definitions/retry_errors" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/retry_errors" - } - } - ] - } - } - } - ] - }, - "retry_max": { - "type": "integer", - "description": "The number of times the job will be retried if it fails. Defaults to 0 and can max be retried 2 times (3 times total).", - "default": 0, - "minimum": 0, - "maximum": 2 - }, - "retry_errors": { - "oneOf": [ - { - "const": "always", - "description": "Retry on any failure (default)." - }, - { - "const": "unknown_failure", - "description": "Retry when the failure reason is unknown." - }, - { - "const": "script_failure", - "description": "Retry when the script failed." - }, - { - "const": "api_failure", - "description": "Retry on API failure." - }, - { - "const": "stuck_or_timeout_failure", - "description": "Retry when the job got stuck or timed out." - }, - { - "const": "runner_system_failure", - "description": "Retry if there is a runner system failure (for example, job setup failed)." - }, - { - "const": "missing_dependency_failure", - "description": "Retry if a dependency is missing." - }, - { - "const": "runner_unsupported", - "description": "Retry if the runner is unsupported." - }, - { - "const": "stale_schedule", - "description": "Retry if a delayed job could not be executed." - }, - { - "const": "job_execution_timeout", - "description": "Retry if the script exceeded the maximum execution time set for the job." - }, - { - "const": "archived_failure", - "description": "Retry if the job is archived and can’t be run." - }, - { - "const": "unmet_prerequisites", - "description": "Retry if the job failed to complete prerequisite tasks." - }, - { - "const": "scheduler_failure", - "description": "Retry if the scheduler failed to assign the job to a runner." - }, - { - "const": "data_integrity_failure", - "description": "Retry if there is a structural integrity problem detected." - } - ] - }, - "interruptible": { - "type": "boolean", - "description": "Interruptible is used to indicate that a job should be canceled if made redundant by a newer pipeline run.", - "default": false - }, - "job": { - "allOf": [ - { - "$ref": "#/definitions/job_template" - }, - { - "anyOf": [ - { - "required": [ - "script" - ] - }, - { - "required": [ - "extends" - ] - }, - { - "required": [ - "trigger" - ] - } - ] - } - ] - }, - "job_template": { - "type": "object", - "additionalProperties": false, - "properties": { - "image": { - "$ref": "#/definitions/image" - }, - "services": { - "$ref": "#/definitions/services" - }, - "before_script": { - "$ref": "#/definitions/before_script" - }, - "after_script": { - "$ref": "#/definitions/after_script" - }, - "rules": { - "$ref": "#/definitions/rules" - }, - "variables": { - "$ref": "#/definitions/variables" - }, - "cache": { - "$ref": "#/definitions/cache" - }, - "secrets": { - "$ref": "#/definitions/secrets" - }, - "script": { - "description": "Shell scripts executed by the Runner. The only required property of jobs. Be careful with special characters (e.g. `:`, `{`, `}`, `&`) and use single or double quotes to avoid issues.", - "oneOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "array", - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "minItems": 1 - } - ] - }, - "stage": { - "type": "string", - "description": "Define what stage the job will run in.", - "default": "test" - }, - "only": { - "$ref": "#/definitions/filter", - "description": "Job will run *only* when these filtering options match." - }, - "extends": { - "description": "The name of one or more jobs to inherit configuration from.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - ] - }, - "needs": { - "description": "The list of jobs in previous stages whose sole completion is needed to start the current job.", - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "job": { - "type": "string" - }, - "artifacts": { - "type": "boolean" - }, - "optional": { - "type": "boolean" - } - }, - "required": [ - "job" - ] - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "pipeline": { - "type": "string" - }, - "job": { - "type": "string" - }, - "artifacts": { - "type": "boolean" - } - }, - "required": [ - "job", - "pipeline" - ] - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "job": { - "type": "string" - }, - "project": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "artifacts": { - "type": "boolean" - } - }, - "required": [ - "job", - "project", - "ref" - ] - } - ] - } - }, - "except": { - "$ref": "#/definitions/filter", - "description": "Job will run *except* for when these filtering options match." - }, - "tags": { - "$ref": "#/definitions/tags" - }, - "allow_failure": { - "$ref": "#/definitions/allow_failure" - }, - "timeout": { - "$ref": "#/definitions/timeout" - }, - "when": { - "$ref": "#/definitions/when" - }, - "start_in": { - "$ref": "#/definitions/start_in" - }, - "dependencies": { - "type": "array", - "description": "Specify a list of job names from earlier stages from which artifacts should be loaded. By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts.", - "items": { - "type": "string" - } - }, - "artifacts": { - "$ref": "#/definitions/artifacts" - }, - "environment": { - "description": "Used to associate environment metadata with a deploy. Environment can have a name and URL attached to it, and will be displayed under /environments under the project.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the environment, e.g. 'qa', 'staging', 'production'.", - "minLength": 1 - }, - "url": { - "type": "string", - "description": "When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.", - "format": "uri", - "pattern": "^(https?://.+|\\$[A-Za-z]+)" - }, - "on_stop": { - "type": "string", - "description": "The name of a job to execute when the environment is about to be stopped." - }, - "action": { - "enum": [ - "start", - "prepare", - "stop" - ], - "description": "Specifies what this job will do. 'start' (default) indicates the job will start the deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.", - "default": "start" - }, - "auto_stop_in": { - "type": "string", - "description": "The amount of time it should take before Gitlab will automatically stop the environment. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'." - }, - "kubernetes": { - "type": "object", - "description": "Used to configure the kubernetes deployment for this environment. This is currently not supported for kubernetes clusters that are managed by Gitlab.", - "properties": { - "namespace": { - "type": "string", - "description": "The kubernetes namespace where this environment should be deployed to.", - "minLength": 1 - } - } - }, - "deployment_tier": { - "type": "string", - "description": "Explicitly specifies the tier of the deployment environment if non-standard environment name is used.", - "enum": [ - "production", - "staging", - "testing", - "development", - "other" - ] - } - }, - "required": [ - "name" - ] - } - ] - }, - "release": { - "type": "object", - "description": "Indicates that the job creates a Release.", - "additionalProperties": false, - "properties": { - "tag_name": { - "type": "string", - "description": "The tag_name must be specified. It can refer to an existing Git tag or can be specified by the user.", - "minLength": 1 - }, - "description": { - "type": "string", - "description": "Specifies the longer description of the Release.", - "minLength": 1 - }, - "name": { - "type": "string", - "description": "The Release name. If omitted, it is populated with the value of release: tag_name." - }, - "ref": { - "type": "string", - "description": "If the release: tag_name doesn’t exist yet, the release is created from ref. ref can be a commit SHA, another tag name, or a branch name." - }, - "milestones": { - "type": "array", - "description": "The title of each milestone the release is associated with.", - "items": { - "type": "string" - } - }, - "released_at": { - "type": "string", - "description": "The date and time when the release is ready. Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.", - "format": "date-time", - "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:Z|[+-][01]\\d:[0-5]\\d)$" - }, - "assets": { - "type": "object", - "additionalProperties": false, - "properties": { - "links": { - "type": "array", - "description": "Include asset links in the release.", - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the link.", - "minLength": 1 - }, - "url": { - "type": "string", - "description": "The URL to download a file.", - "minLength": 1 - }, - "filepath": { - "type": "string", - "description": "The redirect link to the url." - }, - "link_type": { - "type": "string", - "description": "The content kind of what users can download via url.", - "enum": [ - "runbook", - "package", - "image", - "other" - ] - } - }, - "required": [ - "name", - "url" - ] - }, - "minItems": 1 - } - }, - "required": [ - "links" - ] - } - }, - "required": [ - "tag_name", - "description" - ] - }, - "coverage": { - "type": "string", - "description": "Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'. Example: '/Code coverage: \\d+\\.\\d+/'", - "format": "regex", - "pattern": "^/.+/$" - }, - "retry": { - "$ref": "#/definitions/retry" - }, - "parallel": { - "description": "Parallel will split up a single job into several, and provide `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables for the running jobs.", - "oneOf": [ - { - "type": "integer", - "description": "Creates N instances of the same job that run in parallel.", - "default": 0, - "minimum": 2, - "maximum": 50 - }, - { - "type": "object", - "properties": { - "matrix": { - "type": "array", - "description": "Defines different variables for jobs that are running in parallel.", - "items": { - "type": "object", - "description": "Defines environment variables for specific job.", - "additionalProperties": { - "type": [ - "string", - "number", - "array" - ] - } - }, - "maxItems": 50 - } - }, - "additionalProperties": false, - "required": [ - "matrix" - ] - } - ] - }, - "interruptible": { - "$ref": "#/definitions/interruptible" - }, - "resource_group": { - "type": "string", - "description": "Limit job concurrency. Can be used to ensure that the Runner will not run certain jobs simultaneously." - }, - "trigger": { - "description": "Trigger allows you to define downstream pipeline trigger. When a job created from trigger definition is started by GitLab, a downstream pipeline gets created. Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#trigger", - "oneOf": [ - { - "type": "object", - "description": "Trigger a multi-project pipeline. Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#simple-trigger-syntax-for-multi-project-pipelines", - "additionalProperties": false, - "properties": { - "project": { - "description": "Path to the project, e.g. `group/project`, or `group/sub-group/project`.", - "type": "string", - "pattern": "\\S/\\S" - }, - "branch": { - "description": "The branch name that a downstream pipeline will use", - "type": "string" - }, - "strategy": { - "description": "You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend", - "type": "string", - "enum": [ - "depend" - ] - } - }, - "required": [ - "project" - ], - "dependencies": { - "branch": [ - "project" - ] - } - }, - { - "type": "object", - "description": "Trigger a child pipeline. Read more: https://docs.gitlab.com/ee/ci/yaml/README.html#trigger-syntax-for-child-pipeline", - "additionalProperties": false, - "properties": { - "include": { - "oneOf": [ - { - "description": "Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - }, - { - "type": "array", - "description": "References a local file or an artifact from another job to define the pipeline configuration.", - "maxItems": 3, - "items": { - "oneOf": [ - { - "type": "object", - "additionalProperties": false, - "properties": { - "local": { - "description": "Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - } - } - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "template": { - "description": "Name of the template YAML file to use in the pipeline configuration.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - } - } - }, - { - "type": "object", - "additionalProperties": false, - "properties": { - "artifact": { - "description": "Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.", - "type": "string", - "format": "uri-reference", - "pattern": "\\.ya?ml$" - }, - "job": { - "description": "Job name which generates the artifact", - "type": "string" - } - }, - "required": [ - "artifact", - "job" - ] - } - ] - } - } - ] - }, - "strategy": { - "description": "You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend", - "type": "string", - "enum": [ - "depend" - ] - } - } - }, - { - "description": "Path to the project, e.g. `group/project`, or `group/sub-group/project`.", - "type": "string", - "pattern": "\\S/\\S" - } - ] - }, - "inherit": { - "type": "object", - "description": "Controls inheritance of globally-defined defaults and variables. Boolean values control inheritance of all default: or variables: keywords. To inherit only a subset of default: or variables: keywords, specify what you wish to inherit. Anything not listed is not inherited.", - "properties": { - "default": { - "description": "Whether to inherit all globally-defined defaults or not. Or subset of inherited defaults", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "after_script", - "artifacts", - "before_script", - "cache", - "image", - "interruptible", - "retry", - "services", - "tags", - "timeout" - ] - } - } - ] - }, - "variables": { - "description": "Whether to inherit all globally-defined variables or not. Or subset of inherited variables", - "oneOf": [ - { - "type": "boolean" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - "additionalProperties": false - } - }, - "oneOf": [ - { - "properties": { - "when": { - "enum": [ - "delayed" - ] - } - }, - "required": [ - "when", - "start_in" - ] - }, - { - "properties": { - "when": { - "not": { - "enum": [ - "delayed" - ] - } - } - } - } - ] - }, - "tags": { - "type": "array", - "description": "Used to select runners from the list of available runners. A runner must have all tags listed here to run the job.", - "items": { - "type": "string" - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/graphql-code-generator.json b/test/blackbox/docs/JsonSchemaDraft-7/graphql-code-generator.json deleted file mode 100644 index d91373d16e..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/graphql-code-generator.json +++ /dev/null @@ -1,5312 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "definitions": { - "ReactQueryRawPluginConfig": { - "description": "This plugin generates `React-Query` Hooks with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.", - "type": "object", - "properties": { - "fetcher": { - "description": "Customize the fetcher you wish to use in the generated file. React-Query is agnostic to the data-fetcing layer, so you should provide it, or use a custom one.\n\nThe following options are available to use:\n- 'fetch' - requires you to specify endpoint and headers on each call, and uses `fetch` to do the actual http call.\n- `{ endpoint: string, fetchParams: RequestInit }`: hardcode your endpoint and fetch options into the generated output, using the environment `fetch` method. You can also use `process.env.MY_VAR` as endpoint or header value.\n- `file#identifier` - You can use custom fetcher method that should implement the exported `ReactQueryFetcher` interface. Example: `./my-fetcher#myCustomFetcher`.\n- `graphql-request`: Will generate each hook with `client` argument, where you should pass your own `GraphQLClient` (created from `graphql-request`).", - "anyOf": [ - { - "type": "object", - "properties": { - "endpoint": { - "type": "string" - }, - "fetchParams": { - "$ref": "#/definitions/Record" - } - } - }, - { - "type": "object", - "properties": { - "func": { - "type": "string" - }, - "isReactHook": { - "type": "boolean" - } - } - }, - { - "type": "string" - } - ] - }, - "exposeDocument": { - "description": "For each generate query hook adds `document` field with a\ncorresponding GraphQL query. Useful for `queryClient.fetchQuery`.\nDefault value: \"false\"", - "type": "boolean" - }, - "exposeQueryKeys": { - "description": "For each generate query hook adds getKey(variables: QueryVariables) function. Useful for cache updates.\nDefault value: \"false\"", - "type": "boolean" - }, - "exposeFetcher": { - "description": "For each generate query hook addds `fetcher` field with a corresponding GraphQL query using the fetcher.\nIt is useful for `queryClient.fetchQuery` and `queryClient.prefetchQuery`.\nDefault value: \"false\"", - "type": "boolean" - }, - "errorType": { - "description": "Changes the default \"TError\" generic type.\nDefault value: \"unknown\"", - "type": "string" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "RTKConfig": { - "type": "object", - "properties": { - "importBaseApiFrom": { - "description": "Define where to import the base api to inject endpoints into", - "type": "string" - }, - "exportHooks": { - "description": "Whether to export React Hooks from the generated api. Enable only when using the `\"@reduxjs/toolkit/query/react\"` import of `createApi`\nDefault value: \"false\"", - "type": "boolean" - }, - "overrideExisting": { - "description": "Sets the `overrideExisting` option, for example to allow for hot module reloading when running graphql-codegen in watch mode.\nWill directly be injected as code.\nDefault value: \"undefined\"", - "type": "string" - } - } - }, - "RawGenericSdkPluginConfig": { - "description": "This plugin generate a generic SDK (without any Requester implemented), allow you to easily customize the way you fetch your data, without loosing the strongly-typed integration.", - "type": "object", - "properties": { - "usingObservableFrom": { - "description": "usingObservableFrom: \"import Observable from 'zen-observable';\"\nOR\nusingObservableFrom: \"import { Observable } from 'rxjs';\"", - "type": "string" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "ApolloClientHelpersConfig": { - "type": "object", - "properties": { - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "requireKeyFields": { - "type": "boolean", - "description": "Remove optional sign from all `keyFields` fields.\nDefault value: \"false\"" - }, - "requirePoliciesForAllTypes": { - "type": "boolean", - "description": "Remove optional sign from all generated keys of the root TypePolicy.\nDefault value: \"false\"" - } - } - }, - "AddPluginConfig": { - "type": "object", - "properties": { - "placement": { - "description": "Allow you to choose where to add the content.\nDefault value: \"prepend\"", - "enum": [ - "append", - "content", - "prepend" - ], - "type": "string" - }, - "content": { - "description": "The actual content you wish to add, either a string or array of strings.\nYou can also specify a path to a local file and the content if it will be loaded by codegen.", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - } - } - }, - "TimePluginConfig": { - "type": "object", - "properties": { - "format": { - "description": "Customize the Moment format of the output time.\nDefault value: \"YYYY-MM-DDTHH:mm:ssZ\"", - "type": "string" - }, - "message": { - "description": "Customize the comment message\nDefault value: \"'Generated on'\"", - "type": "string" - } - } - }, - "TypeScriptPluginConfig": { - "description": "This plugin generates the base TypeScript types, based on your GraphQL schema.\n\nThe types generated by this plugin are simple, and refers to the exact structure of your schema, and it's used as the base types for other plugins (such as `typescript-operations` / `typescript-resolvers`)", - "type": "object", - "properties": { - "avoidOptionals": { - "description": "This will cause the generator to avoid using TypeScript optionals (`?`) on types,\nso the following definition: `type A { myField: String }` will output `myField: Maybe`\ninstead of `myField?: Maybe`.\nDefault value: \"false\"", - "anyOf": [ - { - "$ref": "#/definitions/AvoidOptionalsConfig" - }, - { - "type": "boolean" - } - ] - }, - "constEnums": { - "description": "Will prefix every generated `enum` with `const`, you can read more about const enums here: https://www.typescriptlang.org/docs/handbook/enums.html.\nDefault value: \"false\"", - "type": "boolean" - }, - "enumsAsTypes": { - "description": "Generates enum as TypeScript `type` instead of `enum`. Useful it you wish to generate `.d.ts` declaration file instead of `.ts`\nDefault value: \"false\"", - "type": "boolean" - }, - "numericEnums": { - "description": "Controls whether to preserve typescript enum values as numbers\nDefault value: \"false\"", - "type": "boolean" - }, - "futureProofEnums": { - "description": "This option controls whether or not a catch-all entry is added to enum type definitions for values that may be added in the future. You also have to set `enumsAsTypes` to true if you wish to use this option.\nThis is useful if you are using `relay`.\nDefault value: \"false\"", - "type": "boolean" - }, - "futureProofUnions": { - "description": "This option controls whether or not a catch-all entry is added to union type definitions for values that may be added in the future.\nThis is useful if you are using `relay`.\nDefault value: \"false\"", - "type": "boolean" - }, - "enumsAsConst": { - "description": "Generates enum as TypeScript `const assertions` instead of `enum`. This can even be used to enable enum-like patterns in plain JavaScript code if you choose not to use TypeScript’s enum construct.\nDefault value: \"false\"", - "type": "boolean" - }, - "onlyOperationTypes": { - "description": "This will cause the generator to emit types for operations only (basically only enums and scalars).\nInteracts well with `preResolveTypes: true`\nDefault value: \"false\"", - "type": "boolean" - }, - "immutableTypes": { - "description": "Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.\nDefault value: \"false\"", - "type": "boolean" - }, - "maybeValue": { - "description": "Allow to override the type value of `Maybe`.\nDefault value: \"T | null\"", - "type": "string" - }, - "noExport": { - "description": "Set to `true` in order to generate output without `export` modifier.\nThis is useful if you are generating `.d.ts` file and want it to be globally available.\nDefault value: \"false\"", - "type": "boolean" - }, - "disableDescriptions": { - "description": "Set the value to `true` in order to disable all description generation.\nDefault value: \"false\"", - "type": "boolean" - }, - "useImplementingTypes": { - "description": "When a GraphQL interface is used for a field, this flag will use the implementing types, instead of the interface itself.\nDefault value: \"false\"", - "type": "boolean" - }, - "wrapEntireFieldDefinitions": { - "type": "boolean", - "description": "Set the to `true` in order to wrap field definitions with `EntireFieldWrapper`.\nThis is useful to allow return types such as Promises and functions for fields.\nDiffers from `wrapFieldDefinitions` in that this wraps the entire field definition if ie. the field is an Array, while\n`wrapFieldDefinitions` will wrap every single value inside the array.\nDefault value: \"true\"" - }, - "entireFieldWrapperValue": { - "type": "string", - "description": "Allow to override the type value of `EntireFieldWrapper`. This wrapper applies outside of Array and Maybe\nunlike `fieldWrapperValue`, that will wrap the inner type.\nDefault value: \"T | Promise | (() => T | Promise)\"" - }, - "allowEnumStringTypes": { - "description": "Allow using enum string values directly.", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema.\nYou can also map the entire enum to an external type by providing a string that of `module#type`." - }, - "declarationKind": { - "description": "Overrides the default output for various GraphQL elements.", - "anyOf": [ - { - "$ref": "#/definitions/DeclarationKindConfig" - }, - { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - } - ] - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "fieldWrapperValue": { - "description": "Allow you to add wrapper for field type, use T as the generic value. Make sure to set `wrapFieldDefinitions` to `true` in order to make this flag work.\nDefault value: \"T\"", - "type": "string" - }, - "wrapFieldDefinitions": { - "description": "Set the to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions.\nDefault value: \"false\"", - "type": "boolean" - }, - "ignoreEnumValuesFromSchema": { - "description": "This will cause the generator to ignore enum values defined in GraphQLSchema\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "TypeScriptDocumentsPluginConfig": { - "description": "This plugin generates TypeScript types based on your GraphQLSchema *and* your GraphQL operations and fragments.\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\n\nNote: In most configurations, this plugin requires you to use `typescript as well, because it depends on its base types.", - "type": "object", - "properties": { - "arrayInputCoercion": { - "description": "The [GraphQL spec]{@link https://spec.graphql.org/draft/#sel-FAHjBJFCAACE_Gh7d}\nallows arrays and a single primitive value for list input. This allows to\ndeactivate that behavior to only accept arrays instead of single values. If\nset to `false`, the definition: `query foo(bar: [Int!]!): Foo` will output\n`bar: Array` instead of `bar: Array | Int` for the variable part.\nDefault value: \"true\"", - "type": "boolean" - }, - "avoidOptionals": { - "description": "This will cause the generator to avoid using TypeScript optionals (`?`) on types,\nso the following definition: `type A { myField: String }` will output `myField: Maybe`\ninstead of `myField?: Maybe`.\nDefault value: \"false\"", - "anyOf": [ - { - "$ref": "#/definitions/AvoidOptionalsConfig" - }, - { - "type": "boolean" - } - ] - }, - "immutableTypes": { - "description": "Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.\nDefault value: \"false\"", - "type": "boolean" - }, - "flattenGeneratedTypes": { - "description": "Flatten fragment spread and inline fragments into a simple selection set before generating.\nDefault value: \"false\"", - "type": "boolean" - }, - "noExport": { - "description": "Set to `true` in order to generate output without `export` modifier.\nThis is useful if you are generating `.d.ts` file and want it to be globally available.\nDefault value: \"false\"", - "type": "boolean" - }, - "globalNamespace": { - "type": "boolean" - }, - "addOperationExport": { - "type": "boolean", - "description": "Add const export of the operation name to output file. Pay attention that the file should be `d.ts`.\nYou can combine it with `near-operation-file preset` and therefore the types will be generated along with graphql file. Then you need to set extension in `presetConfig` to be `.gql.d.ts` and by that you can import `gql` file in `ts` files.\nIt will allow you to get everything with one import: ```import { GetClient, GetClientQuery, GetClientQueryVariables, } from \"./GetClient.gql\";```.\nDefault value: \"false\"" - }, - "preResolveTypes": { - "description": "Uses primitive types where possible.\nSet to `false` in order to use `Pick` and take use the types generated by `typescript` plugin.\nDefault value: \"true\"", - "type": "boolean" - }, - "skipTypeNameForRoot": { - "description": "Avoid adding `__typename` for root types. This is ignored when a selection explictly specifies `__typename`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "exportFragmentSpreadSubTypes": { - "description": "If set to true, it will export the sub-types created in order to make it easier to access fields declared under fragment spread.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema.\nYou can also map the entire enum to an external type by providing a string that of `module#type`." - }, - "declarationKind": { - "description": "Overrides the default output for various GraphQL elements.", - "anyOf": [ - { - "$ref": "#/definitions/DeclarationKindConfig" - }, - { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - } - ] - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "fieldWrapperValue": { - "description": "Allow you to add wrapper for field type, use T as the generic value. Make sure to set `wrapFieldDefinitions` to `true` in order to make this flag work.\nDefault value: \"T\"", - "type": "string" - }, - "wrapFieldDefinitions": { - "description": "Set the to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions.\nDefault value: \"false\"", - "type": "boolean" - }, - "onlyOperationTypes": { - "description": "This will cause the generator to emit types for operations only (basically only enums and scalars)\nDefault value: \"false\"", - "type": "boolean" - }, - "ignoreEnumValuesFromSchema": { - "description": "This will cause the generator to ignore enum values defined in GraphQLSchema\nDefault value: \"false\"", - "type": "boolean" - }, - "wrapEntireFieldDefinitions": { - "type": "boolean", - "description": "Set the to `true` in order to wrap field definitions with `EntireFieldWrapper`.\nThis is useful to allow return types such as Promises and functions for fields.\nDiffers from `wrapFieldDefinitions` in that this wraps the entire field definition if ie. the field is an Array, while\n`wrapFieldDefinitions` will wrap every single value inside the array.\nDefault value: \"true\"" - }, - "entireFieldWrapperValue": { - "type": "string", - "description": "Allow to override the type value of `EntireFieldWrapper`. This wrapper applies outside of Array and Maybe\nunlike `fieldWrapperValue`, that will wrap the inner type.\nDefault value: \"T | Promise | (() => T | Promise)\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "CSharpResolversPluginRawConfig": { - "description": "This plugin generates C# `class` identifier for your schema types.", - "type": "object", - "properties": { - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema." - }, - "namespaceName": { - "description": "Allow you to customize the namespace name.\nDefault value: \"GraphQLCodeGen\"", - "type": "string" - }, - "className": { - "description": "Allow you to customize the parent class name.\nDefault value: \"Types\"", - "type": "string" - }, - "listType": { - "description": "Allow you to customize the list type\nDefault value: \"IEnumerable\"", - "type": "string" - }, - "emitRecords": { - "description": "Emit C# 9.0+ records instead of classes\nDefault value: \"false\"", - "type": "boolean" - }, - "emitJsonAttributes": { - "description": "Should JSON attributes be emitted for produced types and properties ot not\nDefault value: \"true\"", - "type": "boolean" - }, - "jsonAttributesSource": { - "$ref": "#/definitions/JsonAttributesSource", - "description": "Library that should be used to emit JSON attributes. Ignored when `emitJsonAttributes` is `false` or not specified\nDefault value: \"Newtonsoft.Json\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "CSharpOperationsRawPluginConfig": { - "description": "This plugin generates C# `class` based on your GraphQL operations.", - "type": "object", - "properties": { - "namespaceName": { - "description": "Allow you to customize the namespace name.\nDefault value: \"GraphQLCodeGen\"", - "type": "string" - }, - "namedClient": { - "description": "Defined the global value of `namedClient`.", - "type": "string" - }, - "querySuffix": { - "description": "Allows to define a custom suffix for query operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "mutationSuffix": { - "description": "Allows to define a custom suffix for mutation operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "subscriptionSuffix": { - "description": "Allows to define a custom suffix for Subscription operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "typesafeOperation": { - "description": "Allows to generate operation methods with class definitions for request/response parameters\nDefault value: \"false\"", - "type": "boolean" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "SchemaASTConfig": { - "description": "This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.", - "type": "object", - "properties": { - "includeDirectives": { - "description": "Include directives to Schema output.\nDefault value: \"false\"", - "type": "boolean" - }, - "commentDescriptions": { - "description": "Set to true in order to print description as comments (using # instead of \"\"\")\nDefault value: \"false\"", - "type": "boolean" - }, - "sort": { - "description": "Set to true in order get the schema lexicographically sorted before printed.\nDefault value: \"false\"", - "type": "boolean" - }, - "federation": { - "type": "boolean" - } - } - }, - "TypeGraphQLPluginConfig": { - "type": "object", - "properties": { - "decoratorName": { - "$ref": "#/definitions/Partial_1", - "description": "allow overriding of TypeGraphQL decorator types\nDefault value: \"`{ type: 'ObjectType', interface: 'InterfaceType', arguments: 'ArgsType', field: 'Field', input: 'InputType' }`\"" - }, - "decorateTypes": { - "description": "Speciies the objects that will have TypeGraphQL decorators prepended to them, by name. Non-matching types will still be output, but without decorators. If not set, all types will be decorated.", - "type": "string[]" - }, - "avoidOptionals": { - "description": "This will cause the generator to avoid using TypeScript optionals (`?`) on types,\nso the following definition: `type A { myField: String }` will output `myField: Maybe`\ninstead of `myField?: Maybe`.\nDefault value: \"false\"", - "anyOf": [ - { - "$ref": "#/definitions/AvoidOptionalsConfig" - }, - { - "type": "boolean" - } - ] - }, - "constEnums": { - "description": "Will prefix every generated `enum` with `const`, you can read more about const enums here: https://www.typescriptlang.org/docs/handbook/enums.html.\nDefault value: \"false\"", - "type": "boolean" - }, - "enumsAsTypes": { - "description": "Generates enum as TypeScript `type` instead of `enum`. Useful it you wish to generate `.d.ts` declaration file instead of `.ts`\nDefault value: \"false\"", - "type": "boolean" - }, - "numericEnums": { - "description": "Controls whether to preserve typescript enum values as numbers\nDefault value: \"false\"", - "type": "boolean" - }, - "futureProofEnums": { - "description": "This option controls whether or not a catch-all entry is added to enum type definitions for values that may be added in the future. You also have to set `enumsAsTypes` to true if you wish to use this option.\nThis is useful if you are using `relay`.\nDefault value: \"false\"", - "type": "boolean" - }, - "futureProofUnions": { - "description": "This option controls whether or not a catch-all entry is added to union type definitions for values that may be added in the future.\nThis is useful if you are using `relay`.\nDefault value: \"false\"", - "type": "boolean" - }, - "enumsAsConst": { - "description": "Generates enum as TypeScript `const assertions` instead of `enum`. This can even be used to enable enum-like patterns in plain JavaScript code if you choose not to use TypeScript’s enum construct.\nDefault value: \"false\"", - "type": "boolean" - }, - "onlyOperationTypes": { - "description": "This will cause the generator to emit types for operations only (basically only enums and scalars).\nInteracts well with `preResolveTypes: true`\nDefault value: \"false\"", - "type": "boolean" - }, - "immutableTypes": { - "description": "Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.\nDefault value: \"false\"", - "type": "boolean" - }, - "maybeValue": { - "description": "Allow to override the type value of `Maybe`.\nDefault value: \"T | null\"", - "type": "string" - }, - "noExport": { - "description": "Set to `true` in order to generate output without `export` modifier.\nThis is useful if you are generating `.d.ts` file and want it to be globally available.\nDefault value: \"false\"", - "type": "boolean" - }, - "disableDescriptions": { - "description": "Set the value to `true` in order to disable all description generation.\nDefault value: \"false\"", - "type": "boolean" - }, - "useImplementingTypes": { - "description": "When a GraphQL interface is used for a field, this flag will use the implementing types, instead of the interface itself.\nDefault value: \"false\"", - "type": "boolean" - }, - "wrapEntireFieldDefinitions": { - "type": "boolean", - "description": "Set the to `true` in order to wrap field definitions with `EntireFieldWrapper`.\nThis is useful to allow return types such as Promises and functions for fields.\nDiffers from `wrapFieldDefinitions` in that this wraps the entire field definition if ie. the field is an Array, while\n`wrapFieldDefinitions` will wrap every single value inside the array.\nDefault value: \"true\"" - }, - "entireFieldWrapperValue": { - "type": "string", - "description": "Allow to override the type value of `EntireFieldWrapper`. This wrapper applies outside of Array and Maybe\nunlike `fieldWrapperValue`, that will wrap the inner type.\nDefault value: \"T | Promise | (() => T | Promise)\"" - }, - "allowEnumStringTypes": { - "description": "Allow using enum string values directly.", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema.\nYou can also map the entire enum to an external type by providing a string that of `module#type`." - }, - "declarationKind": { - "description": "Overrides the default output for various GraphQL elements.", - "anyOf": [ - { - "$ref": "#/definitions/DeclarationKindConfig" - }, - { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - } - ] - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "fieldWrapperValue": { - "description": "Allow you to add wrapper for field type, use T as the generic value. Make sure to set `wrapFieldDefinitions` to `true` in order to make this flag work.\nDefault value: \"T\"", - "type": "string" - }, - "wrapFieldDefinitions": { - "description": "Set the to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions.\nDefault value: \"false\"", - "type": "boolean" - }, - "ignoreEnumValuesFromSchema": { - "description": "This will cause the generator to ignore enum values defined in GraphQLSchema\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "TypeScriptFilesModulesPluginConfig": { - "description": "This plugin generates TypeScript typings for `.graphql` files containing GraphQL documents, which later on can be consumed using [`graphql-tag/loader`](https://github.com/apollographql/graphql-tag#webpack-preprocessing-with-graphql-tagloader) or use `string` types if you will use the operations as raw strings, and get type-check and type-safety for your imports. This means that any time you import objects from `.graphql` files, your IDE will provide auto-complete.\n\nThis plugin also handles `.graphql` files containing multiple GraphQL documents, and name the imports according to the operation name.\n\n> ⚠ Fragments are not generated with named imports, only as default imports, due to `graphql-tag/loader` behavior.", - "type": "object", - "properties": { - "modulePathPrefix": { - "description": "Allows specifying a module definition path prefix to provide distinction\nbetween generated types.\nDefault value: \"\"", - "type": "string" - }, - "relativeToCwd": { - "description": "By default, only the filename is being used to generate TS module declarations. Setting this to `true` will generate it with a full path based on the CWD.\nDefault value: \"false\"", - "type": "boolean" - }, - "prefix": { - "description": "By default, a wildcard is being added as prefix, you can change that to a custom prefix\nDefault value: \"*\\/\"", - "type": "string" - }, - "type": { - "description": "By default, the named exports will have a type `DocumentNode`. Change this to \"string\" if you only use raw strings.\nDefault value: \"DocumentNode\"", - "enum": [ - "DocumentNode", - "string" - ], - "type": "string" - } - } - }, - "NamedOperationsObjectPluginConfig": { - "type": "object", - "properties": { - "identifierName": { - "description": "Allow you to customize the name of the exported identifier\nDefault value: \"namedOperations\"", - "type": "string" - }, - "useConsts": { - "description": "Will generate a const string instead of regular string.\nDefault value: \"false\"", - "type": "boolean" - } - } - }, - "RawGraphQLRequestPluginConfig": { - "description": "This plugin generates [`graphql-request`](https://www.npmjs.com/package/graphql-request) ready-to-use SDK, which is fully-typed.", - "type": "object", - "properties": { - "rawRequest": { - "description": "By default the `request` method return the `data` or `errors` key from the response. If you need to access the `extensions` key you can use the `rawRequest` method.\nDefault value: \"false\"", - "type": "boolean" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "TypeScriptMongoPluginConfig": { - "type": "object", - "properties": { - "dbTypeSuffix": { - "description": "Customize the suffix for the generated GraphQL `type`s.\nDefault value: \"DbObject\"", - "type": "string" - }, - "dbInterfaceSuffix": { - "description": "Customize the suffix for the generated GraphQL `interface`s.\nDefault value: \"DbObject\"", - "type": "string" - }, - "objectIdType": { - "description": "Customize the type of `_id` fields. You can either specify a type name, or specify `module#type`.\nDefault value: \"mongodb#ObjectId\"", - "type": "string" - }, - "idFieldName": { - "description": "Customize the name of the id field generated after using `@id` directive over a GraphQL field.\nDefault value: \"_id\"", - "type": "string" - }, - "enumsAsString": { - "description": "Replaces generated `enum` values with `string`.\nDefault value: \"true\"", - "type": "boolean" - }, - "avoidOptionals": { - "description": "This will cause the generator to avoid using TypeScript optionals (`?`),\r\nso the following definition: `type A { myField: String }` will output `myField: Maybe`\r\ninstead of `myField?: Maybe`.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "TypeScriptResolversPluginConfig": { - "description": "This plugin generates TypeScript signature for `resolve` functions of your GraphQL API.\nYou can use this plugin a to generate simple resolvers signature based on your GraphQL types, or you can change it's behavior be providing custom model types (mappers).\n\nYou can find a blog post explaining the usage of this plugin here: https://the-guild.dev/blog/better-type-safety-for-resolvers-with-graphql-codegen", - "type": "object", - "properties": { - "useIndexSignature": { - "description": "Adds an index signature to any generates resolver.\nDefault value: \"false\"", - "type": "boolean" - }, - "noSchemaStitching": { - "description": "Disables/Enables Schema Stitching support.\nBy defualt, the resolver signature does not include the support for schema-stitching.\nSet to `false` to enable that.\nDefault value: \"true\"", - "type": "boolean" - }, - "wrapFieldDefinitions": { - "description": "Set to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions. Needed for\ncompatibility with `federation: true` when\nDefault value: \"true\"", - "type": "boolean" - }, - "customResolveInfo": { - "description": "You can provide your custom GraphQLResolveInfo instead of the default one from graphql-js\nDefault value: \"graphql#GraphQLResolveInfo\"", - "type": "string" - }, - "customResolverFn": { - "description": "You can provide your custom ResolveFn instead the default. It has to be a type that uses the generics \nDefault value: \"(parent: TParent, args: TArgs, context: TContext, info: GraphQLResolveInfo) => Promise | TResult\"", - "type": "string" - }, - "allowParentTypeOverride": { - "description": "Allow you to override the `ParentType` generic in each resolver, by avoid enforcing the base type of the generated generic type.\n\nThis will generate `ParentType = Type` instead of `ParentType extends Type = Type` in each resolver.", - "type": "boolean" - }, - "optionalInfoArgument": { - "description": "Sets `info` argument of resolver function to be optional field. Useful for testing.", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "contextType": { - "description": "Use this configuration to set a custom type for your `context`, and it will\neffect all the resolvers, without the need to override it using generics each time.\nIf you wish to use an external type and import it from another file, you can use `add` plugin\nand add the required `import` statement, or you can use a `module#type` syntax.", - "type": "string" - }, - "fieldContextTypes": { - "$ref": "#/definitions/Array_1", - "description": "Use this to set a custom type for a specific field `context`.\nIt will only affect the targeted resolvers.\nYou can either use `Field.Path#ContextTypeName` or `Field.Path#ExternalFileName#ContextTypeName`" - }, - "rootValueType": { - "description": "Use this configuration to set a custom type for the `rootValue`, and it will\neffect resolvers of all root types (Query, Mutation and Subscription), without the need to override it using generics each time.\nIf you wish to use an external type and import it from another file, you can use `add` plugin\nand add the required `import` statement, or you can use both `module#type` or `module#namespace#type` syntax.", - "type": "string" - }, - "mapperTypeSuffix": { - "description": "Adds a suffix to the imported names to prevent name clashes.", - "type": "string" - }, - "mappers": { - "description": "Replaces a GraphQL type usage with a custom type, allowing you to return custom object from\nyour resolvers.\nYou can use both `module#type` and `module#namespace#type` syntax.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "defaultMapper": { - "description": "Allow you to set the default mapper when it's not being override by `mappers` or generics.\nYou can specify a type name, or specify a string in `module#type` or `module#namespace#type` format.\nThe default value of mappers it the TypeScript type generated by `typescript` package.", - "type": "string" - }, - "avoidOptionals": { - "description": "This will cause the generator to avoid using optionals (`?`),\nso all field resolvers must be implemented in order to avoid compilation errors.\nDefault value: \"false\"", - "anyOf": [ - { - "$ref": "#/definitions/AvoidOptionalsConfig" - }, - { - "type": "boolean" - } - ] - }, - "showUnusedMappers": { - "description": "Warns about unused mappers.\nDefault value: \"true\"", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema, supported\nin this plugin because of the need for integration with `typescript` package.\nSee documentation under `typescript` plugin for more information and examples." - }, - "resolverTypeWrapperSignature": { - "description": "Allow you to override `resolverTypeWrapper` definition.\nDefault value: \"Promise | T\"", - "type": "string" - }, - "federation": { - "description": "Supports Apollo Federation\nDefault value: \"false\"", - "type": "boolean" - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "optionalResolveType": { - "description": "Sets the `__resolveType` field as optional field.\nDefault value: \"false\"", - "type": "boolean" - }, - "immutableTypes": { - "description": "Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.\nDefault value: \"false\"", - "type": "boolean" - }, - "namespacedImportName": { - "description": "Prefixes all GraphQL related generated types with that value, as namespaces import.\nYou can use this featuere to allow seperation of plugins to different files.\nDefault value: \"''\"", - "type": "string" - }, - "resolverTypeSuffix": { - "description": "Suffix we add to each generated type resolver.\nDefault value: \"Resolvers\"", - "type": "string" - }, - "allResolversTypeName": { - "description": "The type name to use when exporting all resolvers signature as unified type.\nDefault value: \"Resolvers\"", - "type": "string" - }, - "internalResolversPrefix": { - "type": "string", - "description": "Defines the prefix value used for `__resolveType` and and `__isTypeOf` resolvers.\nIf you are using `mercurius-js`, please set this field to empty string for better compatiblity.\nDefault value: \"'__'\"" - }, - "onlyResolveTypeForInterfaces": { - "type": "boolean", - "description": "Turning this flag to `true` will generate resolver siganture that has only `resolveType` for interfaces, forcing developers to write inherited type resolvers in the type itself.\nDefault value: \"false\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "ApolloAngularRawPluginConfig": { - "description": "This plugin generates Apollo services (`Query`, `Mutation` and `Subscription`) with TypeScript typings.\n\nIt will generate a strongly typed Angular service for every defined query, mutation or subscription. The generated Angular services are ready to inject and use within your Angular component.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nTo shed some more light regards this template, it's recommended to go through the this article: http://apollographql.com/docs/angular/basics/services.html , and to read the Code Generation with Apollo Angular: https://the-guild.dev/blog/apollo-angular-12", - "type": "object", - "properties": { - "apolloAngularVersion": { - "description": "Version of `apollo-angular` package\nDefault value: \"2\"", - "type": "number" - }, - "ngModule": { - "description": "Allows to define `ngModule` as part of the plugin's config so it's globally available.", - "type": "string" - }, - "namedClient": { - "description": "Defined the global value of `namedClient`.", - "type": "string" - }, - "serviceName": { - "description": "Defined the global value of `serviceName`.", - "type": "string" - }, - "serviceProvidedInRoot": { - "description": "Defined the global value of `serviceProvidedInRoot`.", - "type": "boolean" - }, - "serviceProvidedIn": { - "description": "Define the Injector of the SDK class.", - "type": "string" - }, - "sdkClass": { - "description": "Set to `true` in order to generate a SDK service class that uses all generated services.\nDefault value: \"false\"", - "type": "boolean" - }, - "querySuffix": { - "description": "Allows to define a custom suffix for query operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "mutationSuffix": { - "description": "Allows to define a custom suffix for mutation operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "subscriptionSuffix": { - "description": "Allows to define a custom suffix for Subscription operations.\nDefault value: \"GQL\"", - "type": "string" - }, - "apolloAngularPackage": { - "description": "Allows to define a custom Apollo-Angular package to import types from.\nDefault value: \"'apollo-angular'\"", - "type": "string" - }, - "additionalDI": { - "description": "Add additional dependency injections for generated services\nDefault value: \"\"", - "type": "array", - "items": { - "type": "string" - } - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "UrqlRawPluginConfig": { - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) components and HOC with TypeScript typings.", - "type": "object", - "properties": { - "withComponent": { - "description": "Customized the output by enabling/disabling the generated Component.\nDefault value: \"false\"", - "type": "boolean" - }, - "withHooks": { - "description": "Customized the output by enabling/disabling the generated React Hooks.\nDefault value: \"true\"", - "type": "boolean" - }, - "urqlImportFrom": { - "description": "You can specify module that exports components `Query`, `Mutation`, `Subscription` and HOCs\nThis is useful for further abstraction of some common tasks (eg. error handling).\nFilepath relative to generated file can be also specified.\nDefault value: \"urql\"", - "type": "string" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "ReactApolloRawPluginConfig": { - "description": "This plugin generates React Apollo components and HOC with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.", - "type": "object", - "properties": { - "withComponent": { - "description": "Customize the output by enabling/disabling the generated Component (deprecated since Apollo-Client v3). For more details: https://www.apollographql.com/docs/react/api/react/components/\nDefault value: \"false\"", - "type": "boolean" - }, - "withHOC": { - "description": "Customize the output by enabling/disabling the HOC (deprecated since Apollo-Client v3). For more details: https://www.apollographql.com/docs/react/api/react/hoc/\nDefault value: \"false\"", - "type": "boolean" - }, - "withHooks": { - "description": "Customized the output by enabling/disabling the generated React Hooks. For more details: https://www.apollographql.com/docs/react/api/react/hooks/\nDefault value: \"true\"", - "type": "boolean" - }, - "withMutationFn": { - "description": "Customized the output by enabling/disabling the generated mutation function signature.\nDefault value: \"true\"", - "type": "boolean" - }, - "withRefetchFn": { - "description": "Enable generating a function to be used with refetchQueries\nDefault value: \"false\"", - "type": "boolean" - }, - "apolloReactCommonImportFrom": { - "description": "Customize the package where apollo-react common lib is loaded from.\nDefault value: \"@apollo/react-common\"", - "type": "string" - }, - "apolloReactComponentsImportFrom": { - "description": "Customize the package where apollo-react component lib is loaded from.\nDefault value: \"@apollo/react-components\"", - "type": "string" - }, - "apolloReactHocImportFrom": { - "description": "Customize the package where apollo-react HOC lib is loaded from.\nDefault value: \"@apollo/react-hoc\"", - "type": "string" - }, - "apolloReactHooksImportFrom": { - "description": "Customize the package where apollo-react hooks lib is loaded from.\nDefault value: \"@apollo/react-hooks\"", - "type": "string" - }, - "componentSuffix": { - "description": "You can specify a suffix that gets attached to the name of the generated component.\nDefault value: \"Component\"", - "type": "string" - }, - "reactApolloVersion": { - "description": "Sets the version of react-apollo.\nIf you are using the old (deprecated) package of `react-apollo`, please set this configuration to `2`.\nIf you are using Apollo-Client v3, please set this to `3`.\nDefault value: \"3\"", - "enum": [ - 2, - 3 - ], - "type": "number" - }, - "withResultType": { - "description": "Customized the output by enabling/disabling the generated result type.\nDefault value: \"true\"", - "type": "boolean" - }, - "withMutationOptionsType": { - "description": "Customized the output by enabling/disabling the generated mutation option type.\nDefault value: \"true\"", - "type": "boolean" - }, - "addDocBlocks": { - "description": "Allows you to enable/disable the generation of docblocks in generated code.\nSome IDE's (like VSCode) add extra inline information with docblocks, you can disable this feature if your preferred IDE does not.\nDefault value: \"true\"", - "type": "boolean" - }, - "defaultBaseOptions": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "hooksSuffix": { - "type": "string" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "VueApolloRawPluginConfig": { - "description": "This plugin generates", - "type": "object", - "properties": { - "withCompositionFunctions": { - "description": "Customized the output by enabling/disabling the generated Vue composition functions.\nDefault value: \"true\"", - "type": "boolean" - }, - "vueApolloComposableImportFrom": { - "type": "string", - "description": "\nDefault value: \"\"" - }, - "vueCompositionApiImportFrom": { - "type": "string", - "description": "\nDefault value: \"\"" - }, - "addDocBlocks": { - "description": "Allows you to enable/disable the generation of docblocks in generated code.\nSome IDE's (like VSCode) add extra inline information with docblocks, you can disable this feature if your preferred IDE does not.\nDefault value: \"true\"", - "type": "boolean" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "VueApolloSmartOpsRawPluginConfig": { - "description": "This plugin generates Vue Apollo Smart Query, Smart Subscription and mutation operation functions with\nTypeScript typings.\n\nThis plugin relies on some helper functions and types from the `vue-apollo-smart-ops` package. That package also adds\nsome optional functionality for improved error handling in Vue Apollo operations which can be configured in the\ngenerated code from this plugin.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` -\nand thus shares a similar configuration.", - "type": "object", - "properties": { - "withSmartOperationFunctions": { - "description": "Customize the output by enabling/disabling the generated Vue Apollo Smart Operations functions.\nDefault value: \"true\"", - "type": "boolean" - }, - "vueApolloOperationFunctionsImportFrom": { - "description": "The `typescript-vue-apollo-smart-ops` plugin requires three functions that are used to define your\nquery, subscription and mutation operation functions:\n - `createMutationFunction`\n - `createSmartQueryOptionsFunction`\n - `createSmartSubscriptionOptionsFunction`\nBy default these functions are provided by the `vue-apollo-smart-ops` package, but you can substitute\nyour own import path if you want to replace them with other implementations.\nDefault value: \"vue-apollo-smart-ops\"", - "type": "string" - }, - "vueApolloErrorType": { - "description": "The operation functions generated by `typescript-vue-apollo-smart-ops` include some functionality for\nerror handling. This configuration parameter allows you to customise the name of the error type that\nwill be used. The default is to use `ApolloError` from the `apollo-client` package.\nDefault value: \"ApolloError\"", - "type": "string" - }, - "vueApolloErrorTypeImportFrom": { - "description": "The operation functions generated by `typescript-vue-apollo-smart-ops` include some functionality for\nerror handling. This configuration parameter allows you to customise the package where the error type\nwill be imported from. The default is to use `ApolloError` from the `apollo-client` package.\nDefault value: \"vue-apollo-smart-ops\"", - "type": "string" - }, - "vueApolloErrorHandlerFunction": { - "description": "The operation functions generated by `typescript-vue-apollo-smart-ops` include some functionality for\nerror handling. You may supply an error handler function that will be called when an error occurs in\na query, subscription or mutation operation. This function should implement the\n`ApolloOperationErrorHandlerFunction` interface from `vue-apollo-smart-ops` package. You can\nhave a custom handler in your app that shows a notification to the user, for example. If unspecified,\nthis functionality will be disabled and errors handled (or not) by Vue Apollo in the normal way.\nDefault value: \"undefined\"", - "type": "string" - }, - "vueApolloErrorHandlerFunctionImportFrom": { - "description": "The import path where `vueApolloErrorHandlerFunction` should be imported from. Can be a package name\nor a local file path (anything that works in an import statement).\nDefault value: \"undefined\"", - "type": "string" - }, - "vueAppType": { - "description": "The operation functions generated by `typescript-vue-apollo-smart-ops` include some functionality for\nerror handling. When an error occurs, the Vue app instance is passed to the error handler. You can\ncustomise the expected type of the app object. For example, a Nuxt.js app might use `NuxtApp` from\n`@nuxt/types/app` instead. When unspecified, the default type is `Vue` from `vue/types/vue`.\nDefault value: \"undefined\"", - "type": "string" - }, - "vueAppTypeImportFrom": { - "description": "The import path where `vueAppType` should be imported from. Can be a package name or a local file path\n(anything that works in an import statement).\nDefault value: \"undefined\"", - "type": "string" - }, - "addDocBlocks": { - "description": "Allows you to enable/disable the generation of docblocks in generated code.\nSome IDE's (like VSCode) add extra inline information with docblocks, you can disable this feature if\nyour preferred IDE does not.\nDefault value: \"true\"", - "type": "boolean" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "VueUrqlRawPluginConfig": { - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) composition functions with TypeScript typings.", - "type": "object", - "properties": { - "withComposition": { - "description": "Customized the output by enabling/disabling the generated Vue Composition functions.\nDefault value: \"true\"", - "type": "boolean" - }, - "urqlImportFrom": { - "description": "You can specify module that exports components `Query`, `Mutation`, `Subscription`\nThis is useful for further abstraction of some common tasks (eg. error handling).\nFilepath relative to generated file can be also specified.\nDefault value: \"urql\"", - "type": "string" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "StencilApolloRawPluginConfig": { - "description": "This plugin generates Stencil Apollo functional components typings\r\n\r\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.", - "type": "object", - "properties": { - "componentType": { - "$ref": "#/definitions/StencilComponentType", - "description": "Customize the output of the plugin - you can choose to generate a Component class or a function component.\nDefault value: \"functional\"" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "TypeScriptDocumentNodesRawPluginConfig": { - "description": "This plugin generates TypeScript source (`.ts`) file from GraphQL files (`.graphql`).", - "type": "object", - "properties": { - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "namePrefix": { - "description": "Adds prefix to the name\nDefault value: \"\"", - "type": "string" - }, - "nameSuffix": { - "description": "Adds suffix to the name\nDefault value: \"\"", - "type": "string" - }, - "fragmentPrefix": { - "description": "Adds prefix to the fragment variable\nDefault value: \"\"", - "type": "string" - }, - "fragmentSuffix": { - "description": "Adds suffix to the fragment variable\nDefault value: \"\"", - "type": "string" - }, - "noGraphQLTag": { - "description": "Deprecated. Changes the documentMode to `documentNode`.\nDefault value: \"false\"", - "type": "boolean" - }, - "gqlImport": { - "description": "Customize from which module will `gql` be imported from.\nThis is useful if you want to use modules other than `graphql-tag`, e.g. `graphql.macro`.\nDefault value: \"graphql-tag#gql\"", - "type": "string" - }, - "documentNodeImport": { - "description": "Customize from which module will `DocumentNode` be imported from.\nThis is useful if you want to use modules other than `graphql`, e.g. `@graphql-typed-document-node`.\nDefault value: \"graphql#DocumentNode\"", - "type": "string" - }, - "noExport": { - "description": "Set this configuration to `true` if you wish to tell codegen to generate code with no `export` identifier.\nDefault value: \"false\"", - "type": "boolean" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "documentVariablePrefix": { - "description": "Changes the GraphQL operations variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "documentVariableSuffix": { - "description": "Changes the GraphQL operations variables suffix.\nDefault value: \"Document\"", - "type": "string" - }, - "fragmentVariablePrefix": { - "description": "Changes the GraphQL fragments variables prefix.\nDefault value: \"\"", - "type": "string" - }, - "fragmentVariableSuffix": { - "description": "Changes the GraphQL fragments variables suffix.\nDefault value: \"FragmentDoc\"", - "type": "string" - }, - "documentMode": { - "$ref": "#/definitions/DocumentMode", - "description": "Declares how DocumentNode are created:\n- `graphQLTag`: `graphql-tag` or other modules (check `gqlImport`) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client\n- `documentNode`: document nodes will be generated as objects when we generate the templates.\n- `documentNodeImportFragments`: Similar to documentNode except it imports external fragments instead of embedding them.\n- `external`: document nodes are imported from an external file. To be used with `importDocumentNodeExternallyFrom`\n\nNote that some plugins (like `typescript-graphql-request`) also supports `string` for this parameter.\nDefault value: \"graphQLTag\"" - }, - "optimizeDocumentNode": { - "description": "If you are using `documentNode: documentMode | documentNodeImportFragments`, you can set this to `true` to apply document optimizations for your GraphQL document.\nThis will remove all \"loc\" and \"description\" fields from the compiled document, and will remove all empty arrays (such as `directives`, `arguments` and `variableDefinitions`).\nDefault value: \"true\"", - "type": "boolean" - }, - "importOperationTypesFrom": { - "description": "This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using.\nThis is useful if you wish to generate base types from `typescript-operations` plugin into a different file, and import it from there.\nDefault value: \"\"", - "type": "string" - }, - "importDocumentNodeExternallyFrom": { - "description": "This config should be used if `documentMode` is `external`. This has 2 usage:\n- any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use `graphql-tag` in a separate file and export the generated document\n- 'near-operation-file': This is a special mode that is intended to be used with `near-operation-file` preset to import document nodes from those files. If these files are `.graphql` files, we make use of webpack loader.\nDefault value: \"\"", - "type": "string" - }, - "pureMagicComment": { - "description": "This config adds PURE magic comment to the static variables to enforce treeshaking for your bundler.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "JavaApolloAndroidPluginConfig": { - "description": "This plugin and presets creates generated mappers and parsers for a complete type-safe GraphQL requests, for developers that uses Apollo Android runtime.", - "type": "object", - "properties": { - "package": { - "description": "Customize the Java package name for the generated operations. The default package name will be generated according to the output file path.", - "type": "string" - }, - "typePackage": { - "description": "Customize the Java package name for the types generated based on input types.", - "type": "string" - }, - "fragmentPackage": { - "description": "Customize the Java package name for the fragments generated classes.", - "type": "string" - }, - "fileType": { - "$ref": "#/definitions/FileType" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "JavaResolversPluginRawConfig": { - "type": "object", - "properties": { - "package": { - "description": "Customize the Java package name. The default package name will be generated according to the output file path.", - "type": "string" - }, - "mappers": { - "description": "Allow you to replace specific GraphQL types with your custom model classes. This is useful when you want to make sure your resolvers returns the correct class.\r\nThe default value is the values set by `defaultMapper` configuration.\r\nYou can use a direct path to the package, or use `package#class` syntax to have it imported.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "defaultMapper": { - "description": "Sets the default mapper value in case it's not specified by `mappers`.\r\nYou can use a direct path to the package, or use `package#class` syntax to have it imported.\r\nThe default mapper is Java's `Object`.\nDefault value: \"Object\"", - "type": "string" - }, - "className": { - "description": "Allow you to customize the parent class name.\nDefault value: \"Resolvers\"", - "type": "string" - }, - "listType": { - "description": "Allow you to customize the list type.\nDefault value: \"Iterable\"", - "type": "string" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "KotlinResolversPluginRawConfig": { - "type": "object", - "properties": { - "package": { - "description": "Customize the Java package name. The default package name will be generated according to the output file path.", - "type": "string" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema." - }, - "listType": { - "description": "Allow you to customize the list type\nDefault value: \"Iterable\"", - "type": "string" - }, - "withTypes": { - "description": "Allow you to enable generation for the types\nDefault value: \"false\"", - "type": "boolean" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "FlowPluginConfig": { - "description": "This plugin generates Flow types based on your `GraphQLSchema`.\r\n\r\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.", - "type": "object", - "properties": { - "useFlowExactObjects": { - "description": "Generates Flow types as Exact types.\nDefault value: \"true\"", - "type": "boolean" - }, - "useFlowReadOnlyTypes": { - "description": "Generates read-only Flow types\nDefault value: \"false\"", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema.\nYou can also map the entire enum to an external type by providing a string that of `module#type`." - }, - "declarationKind": { - "description": "Overrides the default output for various GraphQL elements.", - "anyOf": [ - { - "$ref": "#/definitions/DeclarationKindConfig" - }, - { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - } - ] - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "fieldWrapperValue": { - "description": "Allow you to add wrapper for field type, use T as the generic value. Make sure to set `wrapFieldDefinitions` to `true` in order to make this flag work.\nDefault value: \"T\"", - "type": "string" - }, - "wrapFieldDefinitions": { - "description": "Set the to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions.\nDefault value: \"false\"", - "type": "boolean" - }, - "onlyOperationTypes": { - "description": "This will cause the generator to emit types for operations only (basically only enums and scalars)\nDefault value: \"false\"", - "type": "boolean" - }, - "ignoreEnumValuesFromSchema": { - "description": "This will cause the generator to ignore enum values defined in GraphQLSchema\nDefault value: \"false\"", - "type": "boolean" - }, - "wrapEntireFieldDefinitions": { - "type": "boolean", - "description": "Set the to `true` in order to wrap field definitions with `EntireFieldWrapper`.\nThis is useful to allow return types such as Promises and functions for fields.\nDiffers from `wrapFieldDefinitions` in that this wraps the entire field definition if ie. the field is an Array, while\n`wrapFieldDefinitions` will wrap every single value inside the array.\nDefault value: \"true\"" - }, - "entireFieldWrapperValue": { - "type": "string", - "description": "Allow to override the type value of `EntireFieldWrapper`. This wrapper applies outside of Array and Maybe\nunlike `fieldWrapperValue`, that will wrap the inner type.\nDefault value: \"T | Promise | (() => T | Promise)\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "RawFlowResolversConfig": { - "description": "This plugin generates resolvers signature based on your `GraphQLSchema`.\n\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.\n\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.", - "type": "object", - "properties": { - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "contextType": { - "description": "Use this configuration to set a custom type for your `context`, and it will\neffect all the resolvers, without the need to override it using generics each time.\nIf you wish to use an external type and import it from another file, you can use `add` plugin\nand add the required `import` statement, or you can use a `module#type` syntax.", - "type": "string" - }, - "fieldContextTypes": { - "$ref": "#/definitions/Array_1", - "description": "Use this to set a custom type for a specific field `context`.\nIt will only affect the targeted resolvers.\nYou can either use `Field.Path#ContextTypeName` or `Field.Path#ExternalFileName#ContextTypeName`" - }, - "rootValueType": { - "description": "Use this configuration to set a custom type for the `rootValue`, and it will\neffect resolvers of all root types (Query, Mutation and Subscription), without the need to override it using generics each time.\nIf you wish to use an external type and import it from another file, you can use `add` plugin\nand add the required `import` statement, or you can use both `module#type` or `module#namespace#type` syntax.", - "type": "string" - }, - "mapperTypeSuffix": { - "description": "Adds a suffix to the imported names to prevent name clashes.", - "type": "string" - }, - "mappers": { - "description": "Replaces a GraphQL type usage with a custom type, allowing you to return custom object from\nyour resolvers.\nYou can use both `module#type` and `module#namespace#type` syntax.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "defaultMapper": { - "description": "Allow you to set the default mapper when it's not being override by `mappers` or generics.\nYou can specify a type name, or specify a string in `module#type` or `module#namespace#type` format.\nThe default value of mappers it the TypeScript type generated by `typescript` package.", - "type": "string" - }, - "avoidOptionals": { - "description": "This will cause the generator to avoid using optionals (`?`),\nso all field resolvers must be implemented in order to avoid compilation errors.\nDefault value: \"false\"", - "anyOf": [ - { - "$ref": "#/definitions/AvoidOptionalsConfig" - }, - { - "type": "boolean" - } - ] - }, - "showUnusedMappers": { - "description": "Warns about unused mappers.\nDefault value: \"true\"", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema, supported\nin this plugin because of the need for integration with `typescript` package.\nSee documentation under `typescript` plugin for more information and examples." - }, - "resolverTypeWrapperSignature": { - "description": "Allow you to override `resolverTypeWrapper` definition.\nDefault value: \"Promise | T\"", - "type": "string" - }, - "federation": { - "description": "Supports Apollo Federation\nDefault value: \"false\"", - "type": "boolean" - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "optionalResolveType": { - "description": "Sets the `__resolveType` field as optional field.\nDefault value: \"false\"", - "type": "boolean" - }, - "immutableTypes": { - "description": "Generates immutable types by adding `readonly` to properties and uses `ReadonlyArray`.\nDefault value: \"false\"", - "type": "boolean" - }, - "namespacedImportName": { - "description": "Prefixes all GraphQL related generated types with that value, as namespaces import.\nYou can use this featuere to allow seperation of plugins to different files.\nDefault value: \"''\"", - "type": "string" - }, - "resolverTypeSuffix": { - "description": "Suffix we add to each generated type resolver.\nDefault value: \"Resolvers\"", - "type": "string" - }, - "allResolversTypeName": { - "description": "The type name to use when exporting all resolvers signature as unified type.\nDefault value: \"Resolvers\"", - "type": "string" - }, - "internalResolversPrefix": { - "type": "string", - "description": "Defines the prefix value used for `__resolveType` and and `__isTypeOf` resolvers.\nIf you are using `mercurius-js`, please set this field to empty string for better compatiblity.\nDefault value: \"'__'\"" - }, - "onlyResolveTypeForInterfaces": { - "type": "boolean", - "description": "Turning this flag to `true` will generate resolver siganture that has only `resolveType` for interfaces, forcing developers to write inherited type resolvers in the type itself.\nDefault value: \"false\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "FlowDocumentsPluginConfig": { - "description": "This plugin generates Flow types based on your `GraphQLSchema` and your GraphQL operations and fragments.\r\n\r\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\r\n\r\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.", - "type": "object", - "properties": { - "useFlowExactObjects": { - "description": "Generates Flow types as Exact types.\nDefault value: \"true\"", - "type": "boolean" - }, - "useFlowReadOnlyTypes": { - "description": "Generates read-only Flow types\nDefault value: \"false\"", - "type": "boolean" - }, - "flattenGeneratedTypes": { - "description": "Flatten fragment spread and inline fragments into a simple selection set before generating.\nDefault value: \"false\"", - "type": "boolean" - }, - "preResolveTypes": { - "description": "Uses primitive types where possible.\nSet to `false` in order to use `Pick` and take use the types generated by `typescript` plugin.\nDefault value: \"true\"", - "type": "boolean" - }, - "skipTypeNameForRoot": { - "description": "Avoid adding `__typename` for root types. This is ignored when a selection explictly specifies `__typename`.\nDefault value: \"false\"", - "type": "boolean" - }, - "globalNamespace": { - "description": "Puts all generated code under `global` namespace. Useful for Stencil integration.\nDefault value: \"false\"", - "type": "boolean" - }, - "operationResultSuffix": { - "description": "Adds a suffix to generated operation result type names\nDefault value: \"\"", - "type": "string" - }, - "dedupeOperationSuffix": { - "description": "Set this configuration to `true` if you wish to make sure to remove duplicate operation name suffix.\nDefault value: \"false\"", - "type": "boolean" - }, - "omitOperationSuffix": { - "description": "Set this configuration to `true` if you wish to disable auto add suffix of operation name, like `Query`, `Mutation`, `Subscription`, `Fragment`.\nDefault value: \"false\"", - "type": "boolean" - }, - "exportFragmentSpreadSubTypes": { - "description": "If set to true, it will export the sub-types created in order to make it easier to access fields declared under fragment spread.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "If set to true, it will enable support for parsing variables on fragments.\nDefault value: \"false\"", - "type": "boolean" - }, - "addUnderscoreToArgsType": { - "description": "Adds `_` to generated `Args` types in order to avoid duplicate identifiers.", - "type": "boolean" - }, - "enumValues": { - "$ref": "#/definitions/EnumValuesMap", - "description": "Overrides the default value of enum values declared in your GraphQL schema.\nYou can also map the entire enum to an external type by providing a string that of `module#type`." - }, - "declarationKind": { - "description": "Overrides the default output for various GraphQL elements.", - "anyOf": [ - { - "$ref": "#/definitions/DeclarationKindConfig" - }, - { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - } - ] - }, - "enumPrefix": { - "description": "Allow you to disable prefixing for generated enums, works in combination with `typesPrefix`.\nDefault value: \"true\"", - "type": "boolean" - }, - "fieldWrapperValue": { - "description": "Allow you to add wrapper for field type, use T as the generic value. Make sure to set `wrapFieldDefinitions` to `true` in order to make this flag work.\nDefault value: \"T\"", - "type": "string" - }, - "wrapFieldDefinitions": { - "description": "Set the to `true` in order to wrap field definitions with `FieldWrapper`.\nThis is useful to allow return types such as Promises and functions.\nDefault value: \"false\"", - "type": "boolean" - }, - "onlyOperationTypes": { - "description": "This will cause the generator to emit types for operations only (basically only enums and scalars)\nDefault value: \"false\"", - "type": "boolean" - }, - "ignoreEnumValuesFromSchema": { - "description": "This will cause the generator to ignore enum values defined in GraphQLSchema\nDefault value: \"false\"", - "type": "boolean" - }, - "wrapEntireFieldDefinitions": { - "type": "boolean", - "description": "Set the to `true` in order to wrap field definitions with `EntireFieldWrapper`.\nThis is useful to allow return types such as Promises and functions for fields.\nDiffers from `wrapFieldDefinitions` in that this wraps the entire field definition if ie. the field is an Array, while\n`wrapFieldDefinitions` will wrap every single value inside the array.\nDefault value: \"true\"" - }, - "entireFieldWrapperValue": { - "type": "string", - "description": "Allow to override the type value of `EntireFieldWrapper`. This wrapper applies outside of Array and Maybe\nunlike `fieldWrapperValue`, that will wrap the inner type.\nDefault value: \"T | Promise | (() => T | Promise)\"" - }, - "strictScalars": { - "description": "Makes scalars strict.\n\nIf scalars are found in the schema that are not defined in `scalars`\nan error will be thrown during codegen.\nDefault value: \"false\"", - "type": "boolean" - }, - "defaultScalarType": { - "description": "Allows you to override the type that unknown scalars will have.\nDefault value: \"any\"", - "type": "string" - }, - "scalars": { - "$ref": "#/definitions/ScalarsMap", - "description": "Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type." - }, - "namingConvention": { - "$ref": "#/definitions/NamingConvention", - "description": "Allow you to override the naming convention of the output.\nYou can either override all namings, or specify an object with specific custom naming convention per output.\nThe format of the converter must be a valid `module#method`.\nAllowed values for specific output are: `typeNames`, `enumValues`.\nYou can also use \"keep\" to keep all GraphQL names as-is.\nAdditionally you can set `transformUnderscore` to `true` if you want to override the default behavior,\nwhich is to preserves underscores.\n\nAvailable case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`\n[See more](https://github.com/btxtiger/change-case-all)\nDefault value: \"change-case-all#pascalCase\"" - }, - "typesPrefix": { - "description": "Prefixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "typesSuffix": { - "description": "Suffixes all the generated types.\nDefault value: \"\"", - "type": "string" - }, - "skipTypename": { - "description": "Does not add __typename to the generated types, unless it was specified in the selection set.\nDefault value: \"false\"", - "type": "boolean" - }, - "nonOptionalTypename": { - "description": "Automatically adds `__typename` field to the generated types, even when they are not specified\nin the selection set, and makes it non-optional\nDefault value: \"false\"", - "type": "boolean" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "dedupeFragments": { - "description": "Removes fragment duplicates for reducing data transfer.\nIt is done by removing sub-fragments imports from fragment definition\nInstead - all of them are imported to the Operation node.\nDefault value: \"false\"", - "type": "boolean" - }, - "inlineFragmentTypes": { - "$ref": "#/definitions/InlineFragmentTypeOptions", - "description": "Whether fragment types should be inlined into other operations.\n\"inline\" is the default behavior and will perform deep inlining fragment types within operation type definitions.\n\"combine\" is the previous behavior that uses fragment type references without inlining the types (and might cauuse issues with deeply nested fragment that uses list types).\nDefault value: \"inline\"" - } - } - }, - "IntrospectionPluginConfig": { - "description": "This plugin generates a GraphQL introspection file based on your GraphQL schema.", - "type": "object", - "properties": { - "minify": { - "description": "Set to `true` in order to minify the JSON output.\nDefault value: \"false\"", - "type": "boolean" - }, - "descriptions": { - "description": "Whether to include descriptions in the introspection result.\nDefault value: \"true\"", - "type": "boolean" - }, - "specifiedByUrl": { - "description": "Whether to include `specifiedByUrl` in the introspection result.\nDefault value: \"false\"", - "type": "boolean" - }, - "directiveIsRepeatable": { - "description": "Whether to include `isRepeatable` flag on directives.\nDefault value: \"true\"", - "type": "boolean" - }, - "schemaDescription": { - "description": "Whether to include `description` field on schema.\nDefault value: \"false\"", - "type": "boolean" - }, - "federation": { - "type": "boolean" - } - } - }, - "FragmentMatcherConfig": { - "description": "This plugin generates an introspection file but only with Interfaces and Unions, based on your GraphQLSchema.\n\nIf you are using `apollo-client` and your schema contains `interface` or `union` declaration, it's recommended to use Apollo's Fragment Matcher and the result generated by the plugin.\n\nYou can read more about it in `apollo-client` documentation: https://www.apollographql.com/docs/react/data/fragments/#fragments-on-unions-and-interfaces.\n\nFragment Matcher plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.", - "type": "object", - "properties": { - "module": { - "description": "Compatible only with JSON extension, allow you to choose the export type, either `module.exports` or `export default`. Allowed values are: `commonjs`, `es2015`.\nDefault value: \"es2015\"", - "enum": [ - "commonjs", - "es2015" - ], - "type": "string" - }, - "apolloClientVersion": { - "description": "Compatible only with TS/TSX/JS/JSX extensions, allow you to generate output based on your Apollo-Client version. Valid values are: `2`, `3`.\nDefault value: \"3\"", - "enum": [ - 2, - 3 - ], - "type": "number" - }, - "useExplicitTyping": { - "description": "Create an explicit type based on your schema. This can help IDEs autofill your fragment matcher. This is mostly useful if you do more with your fragment matcher than just pass it to an Apollo-Client.\nDefault value: \"false\"", - "type": "boolean" - }, - "federation": { - "type": "boolean" - } - } - }, - "UrqlIntrospectionConfig": { - "description": "This plugin generates an introspection file for Schema Awareness feature of Urql Cache Exchange\n\nYou can read more about it in `urql` documentation: https://formidable.com/open-source/urql/docs/graphcache/schema-awareness/.\n\nUrql Introspection plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.", - "type": "object", - "properties": { - "module": { - "description": "Compatible only with JSON extension, allow you to choose the export type, either `module.exports` or `export default`. Allowed values are: `commonjs`, `es2015`.\nDefault value: \"es2015\"", - "enum": [ - "commonjs", - "es2015" - ], - "type": "string" - }, - "useTypeImports": { - "type": "boolean", - "description": "Will use `import type {}` rather than `import {}` when importing only types. This gives\ncompatibility with TypeScript's \"importsNotUsedAsValues\": \"error\" option\nDefault value: \"false\"" - }, - "includeScalars": { - "type": "boolean", - "description": "Includes scalar names (instead of an `Any` replacement) in the output when enabled.\nDefault value: \"false\"" - }, - "includeEnums": { - "type": "boolean", - "description": "Includes enums (instead of an `Any` replacement) in the output when enabled.\nDefault value: \"false\"" - }, - "includeInputs": { - "type": "boolean", - "description": "Includes all input objects (instead of an `Any` replacement) in the output when enabled.\nDefault value: \"false\"" - }, - "includeDirectives": { - "type": "boolean", - "description": "Includes all directives in the output when enabled.\nDefault value: \"false\"" - } - } - }, - "ModulesConfig": { - "type": "object", - "properties": { - "baseTypesPath": { - "type": "string", - "description": "Required, should point to the base schema types file.\nThe key of the output is used a the base path for this file." - }, - "importBaseTypesFrom": { - "type": "string", - "description": "Overrides the package import for the base types. Use this if you are within a monorepo and you wish\nto import the base types directly from a different package, and not from a relative path." - }, - "cwd": { - "type": "string", - "description": "Optional, override the `cwd` of the execution. We are using `cwd` to figure out the imports between files. Use this if your execution path is not your project root directory.\nDefault value: \"process.cwd()\"" - }, - "importTypesNamespace": { - "type": "string", - "description": "Optional, override the name of the import namespace used to import from the `baseTypesPath` file.\nDefault value: \"Types\"" - }, - "filename": { - "type": "string", - "description": "Required, sets the file name for the generated files." - }, - "encapsulateModuleTypes": { - "type": "string", - "description": "Configure how to encapsulate the module types, to avoid confusion.\n\n`namespace` (default): will wrap all types in a TypeScript namespace, using the module name.\n`prefix`: will prefix all types from a specific module with the module name.\n`none`: will skip encapsulation, and generate type as-is.\nDefault value: \"namespace\"" - } - } - }, - "NearOperationFileConfig": { - "type": "object", - "properties": { - "baseTypesPath": { - "description": "Required, should point to the base schema types file.\nThe key of the output is used a the base path for this file.\n\nIf you wish to use an NPM package or a local workspace package, make sure to prefix the package name with `~`.", - "type": "string" - }, - "importAllFragmentsFrom": { - "description": "Overrides all external fragments import types by using a specific file path or a package name.\n\nIf you wish to use an NPM package or a local workspace package, make sure to prefix the package name with `~`.", - "type": [ - "string", - "object" - ] - }, - "extension": { - "description": "Optional, sets the extension for the generated files. Use this to override the extension if you are using plugins that requires a different type of extensions (such as `typescript-react-apollo`)\nDefault value: \".generated.ts\"", - "type": "string" - }, - "cwd": { - "description": "Optional, override the `cwd` of the execution. We are using `cwd` to figure out the imports between files. Use this if your execution path is not your project root directory.\nDefault value: \"process.cwd()\"", - "type": "string" - }, - "folder": { - "description": "Optional, defines a folder, (Relative to the source files) where the generated files will be created.\nDefault value: \"''\"", - "type": "string" - }, - "importTypesNamespace": { - "description": "Optional, override the name of the import namespace used to import from the `baseTypesPath` file.\nDefault value: \"Types\"", - "type": "string" - } - } - }, - "ImportTypesConfig": { - "type": "object", - "properties": { - "typesPath": { - "description": "Required, should point to the base schema types file.\nThe key of the output is used a the base path for this file.", - "type": "string" - }, - "importTypesNamespace": { - "description": "Optional, override the name of the import namespace used to import from the `baseTypesPath` file.\nDefault value: \"Types\"", - "type": "string" - } - } - }, - "GqlTagConfig": { - "type": "object", - "properties": {} - }, - "Types.InstanceOrArray": { - "anyOf": [ - { - "$ref": "#/definitions/Types.SchemaWithLoader" - }, - { - "$ref": "#/definitions/Types.SchemaFromCodeFile" - }, - { - "$ref": "#/definitions/Types.UrlSchemaWithOptions" - }, - { - "$ref": "#/definitions/Types.LocalSchemaPathWithOptions" - }, - { - "type": "array", - "items": { - "description": "A URL to your GraphQL endpoint, a local path to `.graphql` file, a glob pattern to your GraphQL schema files, or a JavaScript file that exports the schema to generate code from. This can also be an array which specifies multiple schemas to generate code from. You can read more about the supported formats [here](schema-field#available-formats).", - "anyOf": [ - { - "$ref": "#/definitions/Types.SchemaWithLoader" - }, - { - "$ref": "#/definitions/Types.SchemaFromCodeFile" - }, - { - "$ref": "#/definitions/Types.UrlSchemaWithOptions" - }, - { - "$ref": "#/definitions/Types.LocalSchemaPathWithOptions" - }, - { - "type": "string" - } - ] - } - }, - { - "type": "string" - } - ] - }, - "Types.SchemaWithLoader": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.SchemaWithLoaderOptions" - } - }, - "Types.SchemaWithLoaderOptions": { - "additionalProperties": false, - "description": "Loads schema using a pointer, with a custom loader (code file).", - "type": "object", - "properties": { - "loader": { - "description": "Specify a path to a custom code file (local or module) that will handle the schema loading.", - "type": "string" - } - } - }, - "Types.SchemaFromCodeFile": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.SchemaFromCodeFileOptions" - } - }, - "Types.SchemaFromCodeFileOptions": { - "additionalProperties": false, - "description": "Loads schema using a pointer, without using `require` while looking for schemas in code files.", - "type": "object", - "properties": { - "noRequire": { - "description": "Set this to `true` in order to tell codegen not to try to `require` files in order to find schema/docs", - "type": "boolean" - }, - "noPluck": { - "description": "Set this to `true` in order to tell codegen not to try to extract GraphQL AST strings schema/docs", - "type": "boolean" - }, - "assumeValid": { - "description": "Set this to `true` in order to tell codegen to skip documents validation.", - "type": "boolean" - } - } - }, - "Types.UrlSchemaWithOptions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.UrlSchemaOptions" - } - }, - "Types.UrlSchemaOptions": { - "additionalProperties": false, - "description": "Loads a schema from remote endpoint, with custom http options.", - "type": "object", - "properties": { - "headers": { - "description": "HTTP headers you wish to add to the HTTP request sent by codegen to fetch your GraphQL remote schema.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "customFetch": { - "description": "Specify a Node module name, or a custom file, to be used instead of standard `fetch`", - "type": "string" - }, - "method": { - "description": "HTTP Method to use, either POST (default) or GET.", - "type": "string" - } - } - }, - "Types.LocalSchemaPathWithOptions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.LocalSchemaPathOptions" - } - }, - "Types.LocalSchemaPathOptions": { - "additionalProperties": false, - "description": "Loads a schema a local file or files, with customized options for parsing/loading.", - "type": "object", - "properties": { - "skipGraphQLImport": { - "description": "Skips checks for graphql-import syntax and loads the file as-is, without imports support.\nDefault value: \"true\"", - "type": "boolean" - }, - "commentDescriptions": { - "description": "Converts all GraphQL comments (`#` sign) to descriptions during the parse phase, to make it available\nfor plugins later.\nDefault value: \"false\"", - "type": "boolean" - }, - "assumeValidSDL": { - "description": "Set to true to assume the SDL is valid.\nDefault value: \"false\"", - "type": "boolean" - }, - "noLocation": { - "description": "By default, the parser creates AST nodes that know the location\nin the source that they correspond to. This configuration flag\ndisables that behavior for performance or testing.\nDefault value: \"false\"", - "type": "boolean" - }, - "allowLegacySDLEmptyFields": { - "description": "If enabled, the parser will parse empty fields sets in the Schema\nDefinition Language. Otherwise, the parser will follow the current\nspecification.\n\nThis option is provided to ease adoption of the final SDL specification\nand will be removed in v16.\nDefault value: \"false\"", - "type": "boolean" - }, - "allowLegacySDLImplementsInterfaces": { - "description": "If enabled, the parser will parse implemented interfaces with no `&`\ncharacter between each interface. Otherwise, the parser will follow the\ncurrent specification.\n\nThis option is provided to ease adoption of the final SDL specification\nand will be removed in v16.\nDefault value: \"false\"", - "type": "boolean" - }, - "experimentalFragmentVariables": { - "description": "EXPERIMENTAL:\n\nIf enabled, the parser will understand and parse variable definitions\ncontained in a fragment definition. They'll be represented in the\n`variableDefinitions` field of the FragmentDefinitionNode.\n\nThe syntax is identical to normal, query-defined variables. For example:\n\n fragment A($var: Boolean = false) on T {\n ...\n }\n\nNote: this feature is experimental and may change or be removed in the\nfuture.\nDefault value: \"false\"", - "type": "boolean" - } - } - }, - "Types.RequireExtension": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "Types.InstanceOrArray_1": { - "anyOf": [ - { - "$ref": "#/definitions/Types.CustomDocumentLoader" - }, - { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/Types.CustomDocumentLoader" - }, - { - "type": "string" - } - ] - } - }, - { - "type": "string" - } - ] - }, - "Types.CustomDocumentLoader": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.CustomDocumentLoaderOptions" - } - }, - "Types.CustomDocumentLoaderOptions": { - "additionalProperties": false, - "description": "Specify a path to a custom loader for your GraphQL documents.", - "type": "object", - "properties": { - "loader": { - "description": "Specify a path to a custom code file (local or module) that will handle the documents loading.", - "type": "string" - } - } - }, - "__type": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/T" - } - }, - "T": { - "type": "object" - }, - "Types.PluginConfig": { - "$ref": "#/definitions/__type" - }, - "Types.ConfiguredOutput": { - "additionalProperties": false, - "type": "object", - "properties": { - "plugins": { - "type": "array", - "items": { - "$ref": "#/definitions/GeneratedPluginsMap" - }, - "description": "List of plugins to apply to this current output file.\n\nYou can either specify plugins from the community using the NPM package name (after you installed it in your project), or you can use a path to a local file for custom plugins.\n\nYou can find a list of available plugins here: https://graphql-code-generator.com/docs/plugins/index\nNeed a custom plugin? read this: https://graphql-code-generator.com/docs/custom-codegen/index" - }, - "preset": { - "description": "If your setup uses Preset to have a more dynamic setup and output, set the name of your preset here.\n\nPresets are a way to have more than one file output, for example: https://graphql-code-generator.com/docs/presets/near-operation-file\n\nYou can either specify a preset from the community using the NPM package name (after you installed it in your project), or you can use a path to a local file for a custom preset.\n\nList of available presets: https://graphql-code-generator.com/docs/presets/presets-index", - "anyOf": [ - { - "type": "object", - "properties": { - "buildGeneratesSection": { - "type": "object" - } - } - }, - { - "type": "string" - } - ] - }, - "presetConfig": { - "description": "If your setup uses Preset to have a more dynamic setup and output, set the configuration object of your preset here.\n\nList of available presets: https://graphql-code-generator.com/docs/presets/presets-index", - "type": "object", - "additionalProperties": {} - }, - "overwrite": { - "description": "A flag to overwrite files if they already exist when generating code (`true` by default).\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/codegen-config", - "type": "boolean" - }, - "documents": { - "$ref": "#/definitions/Types.InstanceOrArray_1", - "description": "A pointer(s) to your GraphQL documents: query, mutation, subscription and fragment. These documents will be loaded into for all your output files.\nYou can use one of the following:\n\n- Path to a local `.graphql` file\n- Path to a code file (for example: `.js` or `.tsx`) containing GraphQL operation strings.\n- Glob expression pointing to multiple `.graphql` files\n- Glob expression pointing to multiple code files\n- Inline string containing GraphQL SDL operation definition\n\nYou can specify either a single file, or multiple.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/documents-field" - }, - "schema": { - "$ref": "#/definitions/Types.InstanceOrArray", - "description": "A pointer(s) to your GraphQL schema. This schema will be available only for this specific `generates` record.\nYou can use one of the following:\n\n- URL pointing to a GraphQL endpoint\n- Path to a local `.json` file\n- Path to a local `.graphql` file\n- Glob expression pointing to multiple `.graphql` files\n- Path to a local code file (for example: `.js`) that exports `GraphQLSchema` object\n- Inline string containing GraphQL SDL schema definition\n\nYou can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/schema-field" - }, - "config": { - "additionalProperties": true - }, - "hooks": { - "$ref": "#/definitions/Partial", - "description": "Specifies scripts to run when events are happening in the codegen core.\nHooks defined on that level will effect only the current output files.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/lifecycle-hooks" - } - }, - "allOf": [ - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-react-query" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/ReactQueryRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-rtk-query" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/RTKConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-generic-sdk" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/RawGenericSdkPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-apollo-client-helpers" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/ApolloClientHelpersConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "add" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/AddPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "time" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TimePluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-operations" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptDocumentsPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "c-sharp" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/CSharpResolversPluginRawConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "c-sharp-operations" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/CSharpOperationsRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "schema-ast" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/SchemaASTConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-type-graphql" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeGraphQLPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-graphql-files-modules" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptFilesModulesPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "named-operations-object" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/NamedOperationsObjectPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-graphql-request" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/RawGraphQLRequestPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-mongodb" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptMongoPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-resolvers" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptResolversPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-apollo-angular" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/ApolloAngularRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-urql" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/UrqlRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-react-apollo" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/ReactApolloRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-vue-apollo" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/VueApolloRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-vue-apollo-smart-ops" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/VueApolloSmartOpsRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-vue-urql" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/VueUrqlRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-stencil-apollo" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/StencilApolloRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "typescript-document-nodes" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/TypeScriptDocumentNodesRawPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "java-apollo-android" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/JavaApolloAndroidPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "java-resolvers" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/JavaResolversPluginRawConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "java" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/JavaResolversPluginRawConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "kotlin" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/KotlinResolversPluginRawConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "flow" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/FlowPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "flow-resolvers" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/RawFlowResolversConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "flow-operations" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/FlowDocumentsPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "introspection" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/IntrospectionPluginConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "fragment-matcher" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/FragmentMatcherConfig" - } - } - } - }, - { - "if": { - "properties": { - "plugins": { - "contains": { - "type": "string", - "const": "urql-introspection" - } - } - } - }, - "then": { - "properties": { - "config": { - "$ref": "#/definitions/UrqlIntrospectionConfig" - } - } - } - } - ] - }, - "__type_1": { - "type": "object", - "properties": { - "afterStart": { - "$ref": "#/definitions/T_1", - "description": "Triggered with no arguments when the codegen starts (after the `codegen.yml` has beed parsed).\n\nSpecify a shell command to run." - }, - "beforeDone": { - "$ref": "#/definitions/T_1", - "description": "Triggered with no arguments, right before the codegen closes, or when watch mode is stopped.\n\nSpecify a shell command to run." - }, - "onWatchTriggered": { - "$ref": "#/definitions/T_1", - "description": "Triggered every time a file changes when using watch mode.\nTriggered with two arguments: the type of the event (for example, `changed`) and the path of the file." - }, - "onError": { - "$ref": "#/definitions/T_1", - "description": "Triggered in case of a general error in the codegen. The argument is a string containing the error." - }, - "afterOneFileWrite": { - "$ref": "#/definitions/T_1", - "description": "Triggered after a file is written to the file-system. Executed with the path for the file.\nIf the content of the file hasn't changed since last execution - this hooks won't be triggered.\n\n> This is a very useful hook, you can use it for integration with Prettier or other linters." - }, - "afterAllFileWrite": { - "$ref": "#/definitions/T_1", - "description": "Executed after writing all the files to the file-system.\nTriggered with multiple arguments - paths for all files." - }, - "beforeOneFileWrite": { - "$ref": "#/definitions/T_1", - "description": "Triggered before a file is written to the file-system. Executed with the path for the file.\n\nIf the content of the file hasn't changed since last execution - this hooks won't be triggered." - }, - "beforeAllFileWrite": { - "$ref": "#/definitions/T_1", - "description": "Executed after the codegen has done creating the output and before writing the files to the file-system.\n\nTriggered with multiple arguments - paths for all relevant files.\n\n> Not all the files will be actually written to the file-system, because this is triggered before checking if the file has changed since last execution." - } - } - }, - "T_1": { - "anyOf": [ - { - "type": "array", - "items": { - "type": [ - "string", - "object" - ] - } - }, - { - "type": [ - "string", - "object" - ] - } - ] - }, - "Partial": { - "$ref": "#/definitions/__type_1" - }, - "__type_2": { - "type": "object" - }, - "Types.PackageLoaderFn": { - "$ref": "#/definitions/__type_2" - }, - "Array": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "the name of the NPM package name you wish to look for", - "type": "string" - }, - "identifier": { - "description": "the tag identifier name you wish to look for", - "type": "string" - } - } - } - }, - "__type_3": { - "type": "object" - }, - "Record": { - "$ref": "#/definitions/__type_3" - }, - "ScalarsMap": { - "description": "Scalars map or a string, a map between the GraphQL scalar name and the identifier that should be used", - "anyOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "NamingConvention": { - "anyOf": [ - { - "$ref": "#/definitions/NamingConventionMap" - }, - { - "type": [ - "string", - "object" - ] - } - ] - }, - "NamingConventionMap": { - "additionalProperties": false, - "type": "object", - "properties": { - "enumValues": { - "type": [ - "string", - "object" - ] - }, - "typeNames": { - "type": [ - "string", - "object" - ] - }, - "transformUnderscore": { - "type": "boolean" - } - } - }, - "InlineFragmentTypeOptions": { - "enum": [ - "combine", - "inline" - ], - "type": "string" - }, - "DocumentMode": { - "enum": [ - "documentNode", - "documentNodeImportFragments", - "external", - "graphQLTag", - "string" - ], - "type": "string" - }, - "AvoidOptionalsConfig": { - "type": "object", - "properties": { - "field": { - "type": "boolean" - }, - "object": { - "type": "boolean" - }, - "inputValue": { - "type": "boolean" - }, - "defaultValue": { - "type": "boolean" - } - } - }, - "EnumValuesMap": { - "description": "A raw configuration for enumValues map - can be represented with a single string value for a file path,\na map between enum name and a file path, or a map between enum name and an object with explicit enum values.", - "anyOf": [ - { - "type": "object", - "additionalProperties": { - "anyOf": [ - { - "allOf": [ - { - "type": "object", - "additionalProperties": { - "type": [ - "string", - "number" - ] - } - }, - { - "$ref": "#/definitions/AdditionalProps" - } - ] - }, - { - "type": "string" - } - ] - } - }, - { - "type": "string" - } - ] - }, - "AdditionalProps": { - "type": "object" - }, - "DeclarationKindConfig": { - "type": "object", - "properties": { - "scalar": { - "$ref": "#/definitions/DeclarationKind" - }, - "input": { - "$ref": "#/definitions/DeclarationKind" - }, - "type": { - "$ref": "#/definitions/DeclarationKind" - }, - "interface": { - "$ref": "#/definitions/DeclarationKind" - }, - "arguments": { - "$ref": "#/definitions/DeclarationKind" - } - } - }, - "DeclarationKind": { - "enum": [ - "abstract class", - "class", - "interface", - "type" - ], - "type": "string" - }, - "JsonAttributesSource": { - "enum": [ - "Newtonsoft.Json", - "System.Text.Json" - ], - "type": "string" - }, - "__type_4": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "interface": { - "type": "string" - }, - "field": { - "type": "string" - }, - "input": { - "type": "string" - }, - "arguments": { - "type": "string" - } - } - }, - "Partial_1": { - "$ref": "#/definitions/__type_4" - }, - "Array_1": { - "type": "array", - "items": { - "type": "string" - } - }, - "StencilComponentType": { - "enum": [ - "class", - "functional" - ], - "type": "string" - }, - "FileType": { - "enum": [ - 0, - 1, - 2, - 3 - ], - "type": "number" - }, - "GeneratedPluginsMap": { - "anyOf": [ - { - "type": "object", - "additionalProperties": true, - "properties": { - "typescript-react-query": { - "additionalProperties": false, - "$ref": "#/definitions/ReactQueryRawPluginConfig" - }, - "@graphql-codegen/typescript-react-query": { - "additionalProperties": false, - "$ref": "#/definitions/ReactQueryRawPluginConfig" - }, - "typescript-rtk-query": { - "additionalProperties": false, - "$ref": "#/definitions/RTKConfig" - }, - "@graphql-codegen/typescript-rtk-query": { - "additionalProperties": false, - "$ref": "#/definitions/RTKConfig" - }, - "typescript-generic-sdk": { - "additionalProperties": false, - "$ref": "#/definitions/RawGenericSdkPluginConfig" - }, - "@graphql-codegen/typescript-generic-sdk": { - "additionalProperties": false, - "$ref": "#/definitions/RawGenericSdkPluginConfig" - }, - "typescript-apollo-client-helpers": { - "additionalProperties": false, - "$ref": "#/definitions/ApolloClientHelpersConfig" - }, - "@graphql-codegen/typescript-apollo-client-helpers": { - "additionalProperties": false, - "$ref": "#/definitions/ApolloClientHelpersConfig" - }, - "add": { - "additionalProperties": false, - "$ref": "#/definitions/AddPluginConfig" - }, - "@graphql-codegen/add": { - "additionalProperties": false, - "$ref": "#/definitions/AddPluginConfig" - }, - "time": { - "additionalProperties": false, - "$ref": "#/definitions/TimePluginConfig" - }, - "@graphql-codegen/time": { - "additionalProperties": false, - "$ref": "#/definitions/TimePluginConfig" - }, - "typescript": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptPluginConfig" - }, - "@graphql-codegen/typescript": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptPluginConfig" - }, - "typescript-operations": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptDocumentsPluginConfig" - }, - "@graphql-codegen/typescript-operations": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptDocumentsPluginConfig" - }, - "c-sharp": { - "additionalProperties": false, - "$ref": "#/definitions/CSharpResolversPluginRawConfig" - }, - "@graphql-codegen/c-sharp": { - "additionalProperties": false, - "$ref": "#/definitions/CSharpResolversPluginRawConfig" - }, - "c-sharp-operations": { - "additionalProperties": false, - "$ref": "#/definitions/CSharpOperationsRawPluginConfig" - }, - "@graphql-codegen/c-sharp-operations": { - "additionalProperties": false, - "$ref": "#/definitions/CSharpOperationsRawPluginConfig" - }, - "schema-ast": { - "additionalProperties": false, - "$ref": "#/definitions/SchemaASTConfig" - }, - "@graphql-codegen/schema-ast": { - "additionalProperties": false, - "$ref": "#/definitions/SchemaASTConfig" - }, - "typescript-type-graphql": { - "additionalProperties": false, - "$ref": "#/definitions/TypeGraphQLPluginConfig" - }, - "@graphql-codegen/typescript-type-graphql": { - "additionalProperties": false, - "$ref": "#/definitions/TypeGraphQLPluginConfig" - }, - "typescript-graphql-files-modules": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptFilesModulesPluginConfig" - }, - "@graphql-codegen/typescript-graphql-files-modules": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptFilesModulesPluginConfig" - }, - "named-operations-object": { - "additionalProperties": false, - "$ref": "#/definitions/NamedOperationsObjectPluginConfig" - }, - "@graphql-codegen/named-operations-object": { - "additionalProperties": false, - "$ref": "#/definitions/NamedOperationsObjectPluginConfig" - }, - "typescript-graphql-request": { - "additionalProperties": false, - "$ref": "#/definitions/RawGraphQLRequestPluginConfig" - }, - "@graphql-codegen/typescript-graphql-request": { - "additionalProperties": false, - "$ref": "#/definitions/RawGraphQLRequestPluginConfig" - }, - "typescript-mongodb": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptMongoPluginConfig" - }, - "@graphql-codegen/typescript-mongodb": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptMongoPluginConfig" - }, - "typescript-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptResolversPluginConfig" - }, - "@graphql-codegen/typescript-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptResolversPluginConfig" - }, - "typescript-apollo-angular": { - "additionalProperties": false, - "$ref": "#/definitions/ApolloAngularRawPluginConfig" - }, - "@graphql-codegen/typescript-apollo-angular": { - "additionalProperties": false, - "$ref": "#/definitions/ApolloAngularRawPluginConfig" - }, - "typescript-urql": { - "additionalProperties": false, - "$ref": "#/definitions/UrqlRawPluginConfig" - }, - "@graphql-codegen/typescript-urql": { - "additionalProperties": false, - "$ref": "#/definitions/UrqlRawPluginConfig" - }, - "typescript-react-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/ReactApolloRawPluginConfig" - }, - "@graphql-codegen/typescript-react-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/ReactApolloRawPluginConfig" - }, - "typescript-vue-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/VueApolloRawPluginConfig" - }, - "@graphql-codegen/typescript-vue-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/VueApolloRawPluginConfig" - }, - "typescript-vue-apollo-smart-ops": { - "additionalProperties": false, - "$ref": "#/definitions/VueApolloSmartOpsRawPluginConfig" - }, - "@graphql-codegen/typescript-vue-apollo-smart-ops": { - "additionalProperties": false, - "$ref": "#/definitions/VueApolloSmartOpsRawPluginConfig" - }, - "typescript-vue-urql": { - "additionalProperties": false, - "$ref": "#/definitions/VueUrqlRawPluginConfig" - }, - "@graphql-codegen/typescript-vue-urql": { - "additionalProperties": false, - "$ref": "#/definitions/VueUrqlRawPluginConfig" - }, - "typescript-stencil-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/StencilApolloRawPluginConfig" - }, - "@graphql-codegen/typescript-stencil-apollo": { - "additionalProperties": false, - "$ref": "#/definitions/StencilApolloRawPluginConfig" - }, - "typescript-document-nodes": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptDocumentNodesRawPluginConfig" - }, - "@graphql-codegen/typescript-document-nodes": { - "additionalProperties": false, - "$ref": "#/definitions/TypeScriptDocumentNodesRawPluginConfig" - }, - "java-apollo-android": { - "additionalProperties": false, - "$ref": "#/definitions/JavaApolloAndroidPluginConfig" - }, - "@graphql-codegen/java-apollo-android": { - "additionalProperties": false, - "$ref": "#/definitions/JavaApolloAndroidPluginConfig" - }, - "java-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/JavaResolversPluginRawConfig" - }, - "@graphql-codegen/java-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/JavaResolversPluginRawConfig" - }, - "java": { - "additionalProperties": false, - "$ref": "#/definitions/JavaResolversPluginRawConfig" - }, - "@graphql-codegen/java": { - "additionalProperties": false, - "$ref": "#/definitions/JavaResolversPluginRawConfig" - }, - "kotlin": { - "additionalProperties": false, - "$ref": "#/definitions/KotlinResolversPluginRawConfig" - }, - "@graphql-codegen/kotlin": { - "additionalProperties": false, - "$ref": "#/definitions/KotlinResolversPluginRawConfig" - }, - "flow": { - "additionalProperties": false, - "$ref": "#/definitions/FlowPluginConfig" - }, - "@graphql-codegen/flow": { - "additionalProperties": false, - "$ref": "#/definitions/FlowPluginConfig" - }, - "flow-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/RawFlowResolversConfig" - }, - "@graphql-codegen/flow-resolvers": { - "additionalProperties": false, - "$ref": "#/definitions/RawFlowResolversConfig" - }, - "flow-operations": { - "additionalProperties": false, - "$ref": "#/definitions/FlowDocumentsPluginConfig" - }, - "@graphql-codegen/flow-operations": { - "additionalProperties": false, - "$ref": "#/definitions/FlowDocumentsPluginConfig" - }, - "introspection": { - "additionalProperties": false, - "$ref": "#/definitions/IntrospectionPluginConfig" - }, - "@graphql-codegen/introspection": { - "additionalProperties": false, - "$ref": "#/definitions/IntrospectionPluginConfig" - }, - "fragment-matcher": { - "additionalProperties": false, - "$ref": "#/definitions/FragmentMatcherConfig" - }, - "@graphql-codegen/fragment-matcher": { - "additionalProperties": false, - "$ref": "#/definitions/FragmentMatcherConfig" - }, - "urql-introspection": { - "additionalProperties": false, - "$ref": "#/definitions/UrqlIntrospectionConfig" - }, - "@graphql-codegen/urql-introspection": { - "additionalProperties": false, - "$ref": "#/definitions/UrqlIntrospectionConfig" - } - } - }, - { - "type": "string", - "oneOf": [ - { - "const": "typescript-react-query", - "description": "This plugin generates `React-Query` Hooks with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-react-query\n\n=> Make sure to include \"@graphql-codegen/typescript-react-query\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-react-query", - "description": "This plugin generates `React-Query` Hooks with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-react-query\n\n=> Make sure to include \"@graphql-codegen/typescript-react-query\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-rtk-query", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-rtk-query\n\n=> Make sure to include \"@graphql-codegen/typescript-rtk-query\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-rtk-query", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-rtk-query\n\n=> Make sure to include \"@graphql-codegen/typescript-rtk-query\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-generic-sdk", - "description": "This plugin generate a generic SDK (without any Requester implemented), allow you to easily customize the way you fetch your data, without loosing the strongly-typed integration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-generic-sdk\n\n=> Make sure to include \"@graphql-codegen/typescript-generic-sdk\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-generic-sdk", - "description": "This plugin generate a generic SDK (without any Requester implemented), allow you to easily customize the way you fetch your data, without loosing the strongly-typed integration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-generic-sdk\n\n=> Make sure to include \"@graphql-codegen/typescript-generic-sdk\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-apollo-client-helpers", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-apollo-client-helpers\n\n=> Make sure to include \"@graphql-codegen/typescript-apollo-client-helpers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-apollo-client-helpers", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-apollo-client-helpers\n\n=> Make sure to include \"@graphql-codegen/typescript-apollo-client-helpers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "add", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/add\n\n=> Make sure to include \"@graphql-codegen/add\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/add", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/add\n\n=> Make sure to include \"@graphql-codegen/add\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "time", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/time\n\n=> Make sure to include \"@graphql-codegen/time\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/time", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/time\n\n=> Make sure to include \"@graphql-codegen/time\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript", - "description": "This plugin generates the base TypeScript types, based on your GraphQL schema.\n\nThe types generated by this plugin are simple, and refers to the exact structure of your schema, and it's used as the base types for other plugins (such as `typescript-operations` / `typescript-resolvers`)\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript\n\n=> Make sure to include \"@graphql-codegen/typescript\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript", - "description": "This plugin generates the base TypeScript types, based on your GraphQL schema.\n\nThe types generated by this plugin are simple, and refers to the exact structure of your schema, and it's used as the base types for other plugins (such as `typescript-operations` / `typescript-resolvers`)\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript\n\n=> Make sure to include \"@graphql-codegen/typescript\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-operations", - "description": "This plugin generates TypeScript types based on your GraphQLSchema *and* your GraphQL operations and fragments.\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\n\nNote: In most configurations, this plugin requires you to use `typescript as well, because it depends on its base types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-operations\n\n=> Make sure to include \"@graphql-codegen/typescript-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-operations", - "description": "This plugin generates TypeScript types based on your GraphQLSchema *and* your GraphQL operations and fragments.\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\n\nNote: In most configurations, this plugin requires you to use `typescript as well, because it depends on its base types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-operations\n\n=> Make sure to include \"@graphql-codegen/typescript-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "c-sharp", - "description": "This plugin generates C# `class` identifier for your schema types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/c-sharp\n\n=> Make sure to include \"@graphql-codegen/c-sharp\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/c-sharp", - "description": "This plugin generates C# `class` identifier for your schema types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/c-sharp\n\n=> Make sure to include \"@graphql-codegen/c-sharp\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "c-sharp-operations", - "description": "This plugin generates C# `class` based on your GraphQL operations.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/c-sharp-operations\n\n=> Make sure to include \"@graphql-codegen/c-sharp-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/c-sharp-operations", - "description": "This plugin generates C# `class` based on your GraphQL operations.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/c-sharp-operations\n\n=> Make sure to include \"@graphql-codegen/c-sharp-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "schema-ast", - "description": "This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/schema-ast\n\n=> Make sure to include \"@graphql-codegen/schema-ast\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/schema-ast", - "description": "This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/schema-ast\n\n=> Make sure to include \"@graphql-codegen/schema-ast\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-type-graphql", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-type-graphql\n\n=> Make sure to include \"@graphql-codegen/typescript-type-graphql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-type-graphql", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-type-graphql\n\n=> Make sure to include \"@graphql-codegen/typescript-type-graphql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-graphql-files-modules", - "description": "This plugin generates TypeScript typings for `.graphql` files containing GraphQL documents, which later on can be consumed using [`graphql-tag/loader`](https://github.com/apollographql/graphql-tag#webpack-preprocessing-with-graphql-tagloader) or use `string` types if you will use the operations as raw strings, and get type-check and type-safety for your imports. This means that any time you import objects from `.graphql` files, your IDE will provide auto-complete.\n\nThis plugin also handles `.graphql` files containing multiple GraphQL documents, and name the imports according to the operation name.\n\n> ⚠ Fragments are not generated with named imports, only as default imports, due to `graphql-tag/loader` behavior.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-graphql-files-modules\n\n=> Make sure to include \"@graphql-codegen/typescript-graphql-files-modules\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-graphql-files-modules", - "description": "This plugin generates TypeScript typings for `.graphql` files containing GraphQL documents, which later on can be consumed using [`graphql-tag/loader`](https://github.com/apollographql/graphql-tag#webpack-preprocessing-with-graphql-tagloader) or use `string` types if you will use the operations as raw strings, and get type-check and type-safety for your imports. This means that any time you import objects from `.graphql` files, your IDE will provide auto-complete.\n\nThis plugin also handles `.graphql` files containing multiple GraphQL documents, and name the imports according to the operation name.\n\n> ⚠ Fragments are not generated with named imports, only as default imports, due to `graphql-tag/loader` behavior.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-graphql-files-modules\n\n=> Make sure to include \"@graphql-codegen/typescript-graphql-files-modules\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "named-operations-object", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/named-operations-object\n\n=> Make sure to include \"@graphql-codegen/named-operations-object\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/named-operations-object", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/named-operations-object\n\n=> Make sure to include \"@graphql-codegen/named-operations-object\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-graphql-request", - "description": "This plugin generates [`graphql-request`](https://www.npmjs.com/package/graphql-request) ready-to-use SDK, which is fully-typed.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-graphql-request\n\n=> Make sure to include \"@graphql-codegen/typescript-graphql-request\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-graphql-request", - "description": "This plugin generates [`graphql-request`](https://www.npmjs.com/package/graphql-request) ready-to-use SDK, which is fully-typed.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-graphql-request\n\n=> Make sure to include \"@graphql-codegen/typescript-graphql-request\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-mongodb", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-mongodb\n\n=> Make sure to include \"@graphql-codegen/typescript-mongodb\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-mongodb", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-mongodb\n\n=> Make sure to include \"@graphql-codegen/typescript-mongodb\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-resolvers", - "description": "This plugin generates TypeScript signature for `resolve` functions of your GraphQL API.\nYou can use this plugin a to generate simple resolvers signature based on your GraphQL types, or you can change it's behavior be providing custom model types (mappers).\n\nYou can find a blog post explaining the usage of this plugin here: https://the-guild.dev/blog/better-type-safety-for-resolvers-with-graphql-codegen\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-resolvers\n\n=> Make sure to include \"@graphql-codegen/typescript-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-resolvers", - "description": "This plugin generates TypeScript signature for `resolve` functions of your GraphQL API.\nYou can use this plugin a to generate simple resolvers signature based on your GraphQL types, or you can change it's behavior be providing custom model types (mappers).\n\nYou can find a blog post explaining the usage of this plugin here: https://the-guild.dev/blog/better-type-safety-for-resolvers-with-graphql-codegen\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-resolvers\n\n=> Make sure to include \"@graphql-codegen/typescript-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-apollo-angular", - "description": "This plugin generates Apollo services (`Query`, `Mutation` and `Subscription`) with TypeScript typings.\n\nIt will generate a strongly typed Angular service for every defined query, mutation or subscription. The generated Angular services are ready to inject and use within your Angular component.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nTo shed some more light regards this template, it's recommended to go through the this article: http://apollographql.com/docs/angular/basics/services.html , and to read the Code Generation with Apollo Angular: https://the-guild.dev/blog/apollo-angular-12\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-apollo-angular\n\n=> Make sure to include \"@graphql-codegen/typescript-apollo-angular\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-apollo-angular", - "description": "This plugin generates Apollo services (`Query`, `Mutation` and `Subscription`) with TypeScript typings.\n\nIt will generate a strongly typed Angular service for every defined query, mutation or subscription. The generated Angular services are ready to inject and use within your Angular component.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nTo shed some more light regards this template, it's recommended to go through the this article: http://apollographql.com/docs/angular/basics/services.html , and to read the Code Generation with Apollo Angular: https://the-guild.dev/blog/apollo-angular-12\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-apollo-angular\n\n=> Make sure to include \"@graphql-codegen/typescript-apollo-angular\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-urql", - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) components and HOC with TypeScript typings.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-urql\n\n=> Make sure to include \"@graphql-codegen/typescript-urql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-urql", - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) components and HOC with TypeScript typings.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-urql\n\n=> Make sure to include \"@graphql-codegen/typescript-urql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-react-apollo", - "description": "This plugin generates React Apollo components and HOC with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-react-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-react-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-react-apollo", - "description": "This plugin generates React Apollo components and HOC with TypeScript typings.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-react-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-react-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-vue-apollo", - "description": "This plugin generates\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-vue-apollo", - "description": "This plugin generates\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-vue-apollo-smart-ops", - "description": "This plugin generates Vue Apollo Smart Query, Smart Subscription and mutation operation functions with\nTypeScript typings.\n\nThis plugin relies on some helper functions and types from the `vue-apollo-smart-ops` package. That package also adds\nsome optional functionality for improved error handling in Vue Apollo operations which can be configured in the\ngenerated code from this plugin.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` -\nand thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-apollo-smart-ops\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-apollo-smart-ops\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-vue-apollo-smart-ops", - "description": "This plugin generates Vue Apollo Smart Query, Smart Subscription and mutation operation functions with\nTypeScript typings.\n\nThis plugin relies on some helper functions and types from the `vue-apollo-smart-ops` package. That package also adds\nsome optional functionality for improved error handling in Vue Apollo operations which can be configured in the\ngenerated code from this plugin.\n\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` -\nand thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-apollo-smart-ops\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-apollo-smart-ops\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-vue-urql", - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) composition functions with TypeScript typings.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-urql\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-urql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-vue-urql", - "description": "This plugin generates `urql` (https://github.com/FormidableLabs/urql) composition functions with TypeScript typings.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-vue-urql\n\n=> Make sure to include \"@graphql-codegen/typescript-vue-urql\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-stencil-apollo", - "description": "This plugin generates Stencil Apollo functional components typings\r\n\r\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-stencil-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-stencil-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-stencil-apollo", - "description": "This plugin generates Stencil Apollo functional components typings\r\n\r\nIt extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-stencil-apollo\n\n=> Make sure to include \"@graphql-codegen/typescript-stencil-apollo\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "typescript-document-nodes", - "description": "This plugin generates TypeScript source (`.ts`) file from GraphQL files (`.graphql`).\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-document-nodes\n\n=> Make sure to include \"@graphql-codegen/typescript-document-nodes\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/typescript-document-nodes", - "description": "This plugin generates TypeScript source (`.ts`) file from GraphQL files (`.graphql`).\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/typescript-document-nodes\n\n=> Make sure to include \"@graphql-codegen/typescript-document-nodes\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "java-apollo-android", - "description": "This plugin and presets creates generated mappers and parsers for a complete type-safe GraphQL requests, for developers that uses Apollo Android runtime.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java-apollo-android\n\n=> Make sure to include \"@graphql-codegen/java-apollo-android\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/java-apollo-android", - "description": "This plugin and presets creates generated mappers and parsers for a complete type-safe GraphQL requests, for developers that uses Apollo Android runtime.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java-apollo-android\n\n=> Make sure to include \"@graphql-codegen/java-apollo-android\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "java-resolvers", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java-resolvers\n\n=> Make sure to include \"@graphql-codegen/java-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/java-resolvers", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java-resolvers\n\n=> Make sure to include \"@graphql-codegen/java-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "java", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java\n\n=> Make sure to include \"@graphql-codegen/java\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/java", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/java\n\n=> Make sure to include \"@graphql-codegen/java\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "kotlin", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/kotlin\n\n=> Make sure to include \"@graphql-codegen/kotlin\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/kotlin", - "description": "\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/kotlin\n\n=> Make sure to include \"@graphql-codegen/kotlin\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "flow", - "description": "This plugin generates Flow types based on your `GraphQLSchema`.\r\n\r\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow\n\n=> Make sure to include \"@graphql-codegen/flow\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/flow", - "description": "This plugin generates Flow types based on your `GraphQLSchema`.\r\n\r\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow\n\n=> Make sure to include \"@graphql-codegen/flow\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "flow-resolvers", - "description": "This plugin generates resolvers signature based on your `GraphQLSchema`.\n\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.\n\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow-resolvers\n\n=> Make sure to include \"@graphql-codegen/flow-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/flow-resolvers", - "description": "This plugin generates resolvers signature based on your `GraphQLSchema`.\n\nIt generates types for your entire schema: types, input types, enum, interface, scalar and union.\n\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow-resolvers\n\n=> Make sure to include \"@graphql-codegen/flow-resolvers\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "flow-operations", - "description": "This plugin generates Flow types based on your `GraphQLSchema` and your GraphQL operations and fragments.\r\n\r\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\r\n\r\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow-operations\n\n=> Make sure to include \"@graphql-codegen/flow-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/flow-operations", - "description": "This plugin generates Flow types based on your `GraphQLSchema` and your GraphQL operations and fragments.\r\n\r\nIt generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.\r\n\r\nThis plugin requires you to use `@graphql-codegen/flow` as well, because it depends on it's types.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/flow-operations\n\n=> Make sure to include \"@graphql-codegen/flow-operations\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "introspection", - "description": "This plugin generates a GraphQL introspection file based on your GraphQL schema.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/introspection\n\n=> Make sure to include \"@graphql-codegen/introspection\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/introspection", - "description": "This plugin generates a GraphQL introspection file based on your GraphQL schema.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/introspection\n\n=> Make sure to include \"@graphql-codegen/introspection\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "fragment-matcher", - "description": "This plugin generates an introspection file but only with Interfaces and Unions, based on your GraphQLSchema.\n\nIf you are using `apollo-client` and your schema contains `interface` or `union` declaration, it's recommended to use Apollo's Fragment Matcher and the result generated by the plugin.\n\nYou can read more about it in `apollo-client` documentation: https://www.apollographql.com/docs/react/data/fragments/#fragments-on-unions-and-interfaces.\n\nFragment Matcher plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/fragment-matcher\n\n=> Make sure to include \"@graphql-codegen/fragment-matcher\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/fragment-matcher", - "description": "This plugin generates an introspection file but only with Interfaces and Unions, based on your GraphQLSchema.\n\nIf you are using `apollo-client` and your schema contains `interface` or `union` declaration, it's recommended to use Apollo's Fragment Matcher and the result generated by the plugin.\n\nYou can read more about it in `apollo-client` documentation: https://www.apollographql.com/docs/react/data/fragments/#fragments-on-unions-and-interfaces.\n\nFragment Matcher plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/fragment-matcher\n\n=> Make sure to include \"@graphql-codegen/fragment-matcher\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "urql-introspection", - "description": "This plugin generates an introspection file for Schema Awareness feature of Urql Cache Exchange\n\nYou can read more about it in `urql` documentation: https://formidable.com/open-source/urql/docs/graphcache/schema-awareness/.\n\nUrql Introspection plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/urql-introspection\n\n=> Make sure to include \"@graphql-codegen/urql-introspection\" in your package.json file and install your dependencies.\n\n" - }, - { - "const": "@graphql-codegen/urql-introspection", - "description": "This plugin generates an introspection file for Schema Awareness feature of Urql Cache Exchange\n\nYou can read more about it in `urql` documentation: https://formidable.com/open-source/urql/docs/graphcache/schema-awareness/.\n\nUrql Introspection plugin accepts a TypeScript / JavaScript or a JSON file as an output _(`.ts, .tsx, .js, .jsx, .json`)_.\n\nBoth in TypeScript and JavaScript a default export is being used.\n\n> The output is based on the output you choose for the output file name.\n\nFor more details and documentation: https://graphql-code-generator.com/docs/plugins/urql-introspection\n\n=> Make sure to include \"@graphql-codegen/urql-introspection\" in your package.json file and install your dependencies.\n\n" - } - ] - }, - { - "type": "string", - "description": "Point to a custom plugin loaded from your file-system.", - "pattern": "(\\\\?([^\\/]*[\\/])*)([^\\/]+)$" - }, - { - "type": "string", - "description": "You can point to any third-party module from node_modules that matches the requirements of a GraphQL Codegen plugin." - } - ] - } - }, - "description": "Represents the root YAML schema for the config file.", - "additionalProperties": false, - "type": "object", - "properties": { - "schema": { - "$ref": "#/definitions/Types.InstanceOrArray", - "description": "A pointer(s) to your GraphQL schema. This schema will be the base schema for all your outputs.\nYou can use one of the following:\n\n- URL pointing to a GraphQL endpoint\n- Path to a local `.json` file\n- Path to a local `.graphql` file\n- Glob expression pointing to multiple `.graphql` files\n- Path to a local code file (for example: `.js`) that exports `GraphQLSchema` object\n- Inline string containing GraphQL SDL schema definition\n\nYou can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/schema-field" - }, - "require": { - "$ref": "#/definitions/Types.RequireExtension", - "description": "A path to a file which defines custom Node.JS require() handlers for custom file extensions.\nThis is essential if the code generator has to go through files which require other files in an unsupported format (by default).\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/require-field\nSee more information about require.extensions: https://gist.github.com/jamestalmage/df922691475cff66c7e6.\n\nNote: values that specified in your .yml file will get loaded after loading the config .yml file." - }, - "customFetch": { - "description": "Name for a library that implements `fetch`.\nUse this to tell codegen to use that to fetch schemas in a custom way.", - "type": "string" - }, - "documents": { - "$ref": "#/definitions/Types.InstanceOrArray_1", - "description": "A pointer(s) to your GraphQL documents: query, mutation, subscription and fragment. These documents will be loaded into for all your output files.\nYou can use one of the following:\n\n- Path to a local `.graphql` file\n- Path to a code file (for example: `.js` or `.tsx`) containing GraphQL operation strings.\n- Glob expression pointing to multiple `.graphql` files\n- Glob expression pointing to multiple code files\n- Inline string containing GraphQL SDL operation definition\n\nYou can specify either a single file, or multiple.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/documents-field" - }, - "config": { - "$ref": "#/definitions/Types.PluginConfig", - "description": "Configuration object containing key => value that will be passes to the plugins.\nSpecifying configuration in this level of your configuration file will pass it to all plugins, in all outputs.\n\nThe options may vary depends on what plugins you are using.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/config-field" - }, - "generates": { - "description": "A map where the key represents an output path for the generated code and the value represents a set of options which are relevant for that specific file.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/codegen-config", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Types.ConfiguredOutput" - } - }, - "overwrite": { - "description": "A flag to overwrite files if they already exist when generating code (`true` by default).\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/codegen-config", - "type": "boolean" - }, - "watch": { - "description": "A flag to trigger codegen when there are changes in the specified GraphQL schemas.\n\nYou can either specify a boolean to turn it on/off or specify an array of glob patterns to add custom files to the watch.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/development-workflow#watch-mode", - "anyOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "type": [ - "string", - "boolean" - ] - } - ] - }, - "watchConfig": { - "description": "Allows overriding the behavior of watch to use stat polling over native file watching support.\n\nConfig fields have the same defaults and sematics as the identically named ones for chokidar.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/development-workflow#watch-mode", - "type": "object", - "properties": { - "usePolling": { - "type": "boolean" - }, - "interval": { - "type": "number" - } - } - }, - "silent": { - "description": "A flag to suppress printing errors when they occur.", - "type": "boolean" - }, - "errorsOnly": { - "description": "A flag to print only errors.", - "type": "boolean" - }, - "pluginLoader": { - "$ref": "#/definitions/Types.PackageLoaderFn", - "description": "If you are using the programmatic API in a browser environment, you can override this configuration to load your plugins in a way different than require." - }, - "pluginContext": { - "description": "Additional context passed to plugins", - "type": "object", - "additionalProperties": {} - }, - "pluckConfig": { - "description": "Allows you to override the configuration for `@graphql-tools/graphql-tag-pluck`, the tool that extracts your GraphQL operations from your code files.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/documents-field#graphql-tag-pluck", - "type": "object", - "properties": { - "modules": { - "$ref": "#/definitions/Array", - "description": "An array of package name and identifier that will be used to track down your gql usages and imports. Use this if your code files imports gql from another library or you have a custom gql tag. identifier is the named export, so don't provide it if the tag function is imported as default." - }, - "magicComment": { - "description": "Configures the magic GraphQL comments to look for. The default is `GraphQL`.", - "type": "string" - }, - "globalIdentifier": { - "description": "Overrides the name of the default GraphQL name identifier.", - "type": "string" - } - } - }, - "hooks": { - "$ref": "#/definitions/Partial", - "description": "Specifies scripts to run when events are happening in the codegen core.\nHooks defined on that level will effect all output files.\n\nFor more details: https://graphql-code-generator.com/docs/getting-started/lifecycle-hooks" - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/netlify.json b/test/blackbox/docs/JsonSchemaDraft-7/netlify.json deleted file mode 100644 index c7bdf44a75..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/netlify.json +++ /dev/null @@ -1,283 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Netlify config schema", - "description": "Config file for Netlify CMS", - "type": "object", - "definitions": { - "collectionItems": { - "properties": { - "fields": { - "$ref": "#/definitions/fields" - }, - "label": { - "description": "label for the collection in the editor UI; defaults to the value of name", - "type": "string" - }, - "label_singular": { - "description": "singular label for certain elements in the editor; defaults to the value of label" - }, - "folder": { - "description": "Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. \nNote: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection \"must have a field that is a valid entry identifier\".", - "type": "string" - }, - "files": { - "$ref": "#/definitions/files" - }, - "path": { - "description": "Path", - "type": "string" - }, - "format": { - "description": "determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.", - "type": "string", - "enum": [ - "yml", - "yaml", - "toml", - "json", - "frontmatter", - "yaml-frontmatter", - "toml-frontmatter", - "json-frontmatter" - ] - }, - "slug": { - "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)).\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date", - "type": "string" - }, - "create": { - "description": "for folder collections only; allows users to create new items in the collection", - "type": "boolean", - "default": false - }, - "hide": { - "description": "hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.", - "type": "boolean", - "default": false - }, - "delete": { - "description": "prevents users from deleting items in a collection; defaults to true", - "type": "boolean", - "default": true - }, - "name": { - "description": "unique identifier for the collection, used as the key when referenced in other contexts", - "type": "string" - }, - "filter": { - "description": "optional filter for folder collections" - }, - "description": { - "description": "optional text, displayed below the label when viewing a collection", - "type": "string" - }, - "extension": { - "description": "the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items", - "type": "string" - } - }, - "required": [ - "name" - ], - "oneOf": [ - { - "required": [ - "files" - ] - }, - { - "required": [ - "folder" - ] - } - ] - }, - "fields": { - "type": "array", - "description": "The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.", - "items": { - "properties": { - "name": { - "type": "string", - "description": "unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)" - }, - "label": { - "type": "string", - "description": "label for the field in the editor UI; defaults to the value of name" - }, - "widget": { - "$ref": "#/definitions/widget" - }, - "default": { - "description": "specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type." - }, - "required": { - "type": "boolean", - "default": true, - "description": "makes a field required; defaults to true" - }, - "pattern": { - "type": "array", - "description": "add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)" - }, - "fields": { - "$ref": "#/definitions/fields" - } - }, - "required": [ - "name" - ] - } - }, - "widget": { - "properties": { - "required": { - "type": "boolean", - "description": "Defaults to True" - }, - "hint": { - "description": "optionally add helper text directly below a widget.", - "type": "string" - }, - "pattern": { - "description": "add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets", - "type": "array" - } - } - }, - "files": { - "type": "array", - "items": { - "properties": { - "name": { - "description": "unique identifier for the file", - "type": "string" - }, - "label": { - "description": "file label", - "type": "string" - }, - "file": { - "description": "unique filepath (relative to the base of the repo).", - "type": "string" - }, - "fields": { - "$ref": "#/definitions/fields" - } - } - } - } - }, - "properties": { - "backend": { - "type": "object", - "description": "specifies how to access the content for your site, including authentication" - }, - "local_backend": { - "type": "boolean", - "description": "Set this property to connect Netlify to a local Git repo instead of a live one" - }, - "publish_mode": {}, - "media_folder": { - "type": "string", - "description": "specifies the folder path where uploaded files should be saved, relative to the base of the repo." - }, - "public_folder": { - "type": "string", - "description": "specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder, with an opening / if one is not already included." - }, - "media_library": { - "description": "Media library integrations are configured via the media_library property, and its value should be an object with at least a name property. A config property can also be used for options that should be passed to the library in use.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "config": { - "type": "object" - } - }, - "required": [ - "name" - ] - }, - "site_url": { - "description": "should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path to create links to live content.", - "type": "string" - }, - "display_url": { - "description": "When the display_url setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com).\nDefaults to site_url.", - "type": "string" - }, - "logo_url": { - "type": "string", - "description": "Logo at the top of the login page. Assumed to be a URL to an image file" - }, - "locale": { - "type": "string", - "default": "en" - }, - "show_preview_links": { - "description": "shows Deploy Preview Links", - "type": "boolean" - }, - "slug": { - "type": "object", - "description": "For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field).\n \nThe slug template can also reference a field value by name, eg. {{title}}. If a field name conflicts with a built in template tag name - for example, if you have a field named slug, and would like to reference that field via {{slug}}, you can do so by adding the explicit fields. prefix, eg. {{fields.slug}}.\n \nAvailable template tags:\n \nAny field can be referenced by wrapping the field name in double curly braces, eg. {{author}} \n{{slug}}: a url-safe version of the title field (or identifier field) for the file \n{{year}}: 4-digit year of the file creation date \n{{month}}: 2-digit month of the file creation date \n{{day}}: 2-digit day of the month of the file creation date \n{{hour}}: 2-digit hour of the file creation date \n{{minute}}: 2-digit minute of the file creation date \n{{second}}: 2-digit second of the file creation date", - "properties": { - "encoding": { - "description": "\nunicode (default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.\nascii: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _, -, ~).", - "enum": [ - "unicode", - "ascii" - ], - "default": "unicode" - }, - "clean_accents": { - "type": "boolean", - "description": "Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding." - }, - "sanitize_replacement": { - "type": "string", - "description": "The replacement string used to substitute unsafe characters; defaults to -" - } - } - }, - "collections": { - "description": "The collections setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml file.", - "type": "array", - "items": { - "$ref": "#/definitions/collectionItems" - } - }, - "editor": { - "description": "This setting changes options for the editor view of the collection. It has one option so far: preview", - "type": "object", - "properties": { - "preview": { - "type": "boolean", - "description": "Enable preview pane for this collection; defaults to true", - "default": true - } - } - }, - "summary": { - "description": "This setting allows the customization of the collection list view. Similar to the slug field, a string with templates can be used to include values of different fields, e.g. {{title}}. This option over-rides the default of title field and identifier_field\nTemplate tags are the same as those for slug, with the following additions: \n\n \n{{filename}} The file name without the extension part. \n{{extension}} The file extension. \n{{commit_date}} The file commit date on supported backends (git based backends). \n{{commit_author}} The file author date on supported backends (git based backends).", - "type": "string" - }, - "sortableFields": { - "type": "array", - "description": "An optional list of sort fields to show in the UI.\nDefaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends.\nWhen author field can't be inferred commit author will be used." - }, - "view_filters": { - "type": "array", - "description": "An optional list of predefined view filters to show in the UI.\nDefaults to an empty list." - } - }, - "required": [ - "backend", - "media_folder", - "collections" - ], - "dependencies": {} -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/portman-config.json b/test/blackbox/docs/JsonSchemaDraft-7/portman-config.json deleted file mode 100644 index 3a3ee4bf2a..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/portman-config.json +++ /dev/null @@ -1,993 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "additionalProperties": false, - "title": "Portman Configuration", - "description": "Portman by Apideck allows you to port your OpenApi Spec to a Postman Collection, inject a powerful test suite, and run your tests with Newman. Details about all configuration options can be found at http://getportman.com.", - "properties": { - "assignVariables": { - "items": { - "additionalProperties": false, - "properties": { - "collectionVariables": { - "items": { - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "requestBodyProp": { - "type": "string" - }, - "responseBodyProp": { - "type": "string" - }, - "responseHeaderProp": { - "type": "string" - }, - "value": {} - }, - "type": "object" - }, - "type": "array" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["collectionVariables"], - "type": "object" - }, - "type": "array" - }, - "globals": { - "additionalProperties": false, - "properties": { - "collectionPreRequestScripts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "keyValueReplacements": { - "additionalProperties": {}, - "type": "object" - }, - "orderOfOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "portmanReplacements": { - "items": { - "additionalProperties": false, - "properties": { - "replaceWith": { - "type": "string" - }, - "searchFor": { - "type": "string" - } - }, - "required": ["searchFor", "replaceWith"], - "type": "object" - }, - "type": "array" - }, - "rawReplacements": { - "items": { - "additionalProperties": false, - "properties": { - "replaceWith": { - "type": "string" - }, - "searchFor": { - "type": "string" - } - }, - "required": ["searchFor", "replaceWith"], - "type": "object" - }, - "type": "array" - }, - "securityOverwrites": { - "additionalProperties": false, - "properties": { - "apiKey": { - "additionalProperties": false, - "properties": { - "in": { - "type": "string" - }, - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": ["value"], - "type": "object" - }, - "basic": { - "additionalProperties": false, - "properties": { - "password": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": ["username", "password"], - "type": "object" - }, - "bearer": { - "additionalProperties": false, - "properties": { - "token": { - "type": "string" - } - }, - "required": ["token"], - "type": "object" - }, - "other": { - "additionalProperties": { - "anyOf": [ - {}, - { - "items": {}, - "type": "array" - } - ] - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": ["type"], - "type": "object" - } - }, - "type": "object" - }, - "valueReplacements": { - "additionalProperties": {}, - "type": "object" - } - }, - "type": "object" - }, - "operationPreRequestScripts": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "scripts": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["scripts"], - "type": "object" - }, - "type": "array" - }, - "overwrites": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "overwriteRequestBody": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "type": "string" - }, - "overwrite": { - "type": "boolean" - }, - "remove": { - "type": "boolean" - }, - "value": {} - }, - "required": ["key"], - "type": "object" - }, - "type": "array" - }, - "overwriteRequestHeaders": { - "items": { - "additionalProperties": false, - "properties": { - "disable": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "overwrite": { - "type": "boolean" - }, - "remove": { - "type": "boolean" - }, - "value": { - "type": [ - "string", - "number", - "boolean" - ] - } - }, - "required": ["key"], - "type": "object" - }, - "type": "array" - }, - "overwriteRequestPathIdVariables": { - "items": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - } - }, - "required": ["enabled"], - "type": "object" - }, - "type": "array" - }, - "overwriteRequestPathVariables": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "type": "string" - }, - "overwrite": { - "type": "boolean" - }, - "value": { - "type": [ - "string", - "number", - "boolean" - ] - } - }, - "required": ["key"], - "type": "object" - }, - "type": "array" - }, - "overwriteRequestQueryParams": { - "items": { - "additionalProperties": false, - "properties": { - "disable": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "overwrite": { - "type": "boolean" - }, - "remove": { - "type": "boolean" - }, - "value": { - "type": [ - "string", - "number", - "boolean" - ] - } - }, - "required": ["key"], - "type": "object" - }, - "type": "array" - }, - "overwriteRequestSecurity": { - "additionalProperties": false, - "properties": { - "apiKey": { - "additionalProperties": false, - "properties": { - "in": { - "type": "string" - }, - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": ["value"], - "type": "object" - }, - "basic": { - "additionalProperties": false, - "properties": { - "password": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": ["username", "password"], - "type": "object" - }, - "bearer": { - "additionalProperties": false, - "properties": { - "token": { - "type": "string" - } - }, - "required": ["token"], - "type": "object" - }, - "other": { - "additionalProperties": { - "anyOf": [ - {}, - { - "items": {}, - "type": "array" - } - ] - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": ["type"], - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": "array" - }, - "tests": { - "additionalProperties": false, - "properties": { - "contentTests": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "responseBodyTests": { - "items": { - "additionalProperties": false, - "properties": { - "key": { - "type": "string" - }, - "value": {} - }, - "required": ["key"], - "type": "object" - }, - "type": "array" - } - }, - "required": ["responseBodyTests"], - "type": "object" - }, - "type": "array" - }, - "contractTests": { - "items": { - "additionalProperties": false, - "properties": { - "contentType": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "headersPresent": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - }, - "jsonBody": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "responseTime": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "maxMs": { - "type": "number" - } - }, - "required": ["enabled", "maxMs"], - "type": "object" - }, - "schemaValidation": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - }, - "statusCode": { - "additionalProperties": false, - "properties": { - "code": { - "type": "number" - }, - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - }, - "statusSuccess": { - "additionalProperties": false, - "properties": { - "enabled": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["enabled"], - "type": "object" - } - }, - "type": "object" - }, - "type": "array" - }, - "extendTests": { - "items": { - "additionalProperties": false, - "properties": { - "append": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "overwrite": { - "type": "boolean" - }, - "tests": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["tests"], - "type": "object" - }, - "type": "array" - }, - "integrationTests": { - "items": { - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "operations": { - "items": { - "additionalProperties": false, - "properties": { - "openApiOperationId": { - "type": "string" - }, - "variations": { - "items": { - "additionalProperties": false, - "properties": { - "assignVariables": { - "items": { - "additionalProperties": false, - "properties": { - "collectionVariables": { - "items": { - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "requestBodyProp": { - "type": "string" - }, - "responseBodyProp": { - "type": "string" - }, - "responseHeaderProp": { - "type": "string" - }, - "value": {} - }, - "type": "object" - }, - "type": "array" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["collectionVariables"], - "type": "object" - }, - "type": "array" - }, - "extendTests": { - "items": { - "additionalProperties": false, - "properties": { - "append": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "overwrite": { - "type": "boolean" - }, - "tests": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["tests"], - "type": "object" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "openApiResponse": { - "type": "string" - }, - "operationPreRequestScripts": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "scripts": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["scripts"], - "type": "object" - }, - "type": "array" - }, - "overwrites": {}, - "tests": {} - }, - "required": ["name", "tests"], - "type": "object" - }, - "type": "array" - } - }, - "required": ["openApiOperationId", "variations"], - "type": "object" - }, - "type": "array" - } - }, - "required": ["name", "operations"], - "type": "object" - }, - "type": "array" - }, - "variationTests": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "variations": { - "items": { - "additionalProperties": false, - "properties": { - "assignVariables": { - "items": { - "additionalProperties": false, - "properties": { - "collectionVariables": { - "items": { - "additionalProperties": false, - "properties": { - "name": { - "type": "string" - }, - "requestBodyProp": { - "type": "string" - }, - "responseBodyProp": { - "type": "string" - }, - "responseHeaderProp": { - "type": "string" - }, - "value": {} - }, - "type": "object" - }, - "type": "array" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["collectionVariables"], - "type": "object" - }, - "type": "array" - }, - "extendTests": { - "items": { - "additionalProperties": false, - "properties": { - "append": { - "type": "boolean" - }, - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "overwrite": { - "type": "boolean" - }, - "tests": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["tests"], - "type": "object" - }, - "type": "array" - }, - "name": { - "type": "string" - }, - "openApiResponse": { - "type": "string" - }, - "operationPreRequestScripts": { - "items": { - "additionalProperties": false, - "properties": { - "excludeForOperations": { - "items": { - "type": "string" - }, - "type": "array" - }, - "openApiOperation": { - "type": "string" - }, - "openApiOperationId": { - "type": "string" - }, - "openApiOperationIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "scripts": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": ["scripts"], - "type": "object" - }, - "type": "array" - }, - "overwrites": {}, - "tests": {} - }, - "required": ["name", "tests"], - "type": "object" - }, - "type": "array" - } - }, - "required": ["variations"], - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "version": { - "type": "number" - } - }, - "type": "object" - } - \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-1_0.json b/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-1_0.json deleted file mode 100644 index f076728421..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-1_0.json +++ /dev/null @@ -1,1338 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://schema.getpostman.com/json/draft-07/collection/v1.0.0/", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a [UID](https://tools.ietf.org/html/rfc4122#section-4.4%29) generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that this is a different collection than it was originally." - }, - "name": { - "type": "string", - "description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Provide a long description of this collection using this field. This field supports markdown syntax to better format the description." - }, - "variables": { - "oneOf": [ - { - "$ref": "#/definitions/variable-list" - }, - { - "type": "null" - } - ] - }, - "order": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "description": "The order array ensures that your requests and folders don't randomly get shuffled up. It holds a sequence of [UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) corresponding to folders and requests.\n *Note that if a folder ID or a request ID (if the request is not already part of a folder) is not included in the order array, the request or the folder will not show up in the collection.*" - }, - "folders_order": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "description": "The folders order array ensures that your requests and folders don't randomly get shuffled up. It holds a sequence of [UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) corresponding to folders and requests.\n *Note that if a folder ID or a request ID (if the request is not already part of a folder) is not included in the order array, the request or the folder will not show up in the collection.*" - }, - "folders": { - "type": "array", - "items": { - "$ref": "#/definitions/folder" - }, - "description": "Folders are the way to go if you want to group your requests and to keep things organised. Folders can also be useful in sequentially requesting a part of the entire collection by using [Postman Collection Runner](https://www.getpostman.com/docs/jetpacks_running_collections) or [Newman](https://github.com/postmanlabs/newman) on a particular folder." - }, - "timestamp": { - "type": "number", - "multipleOf": 1 - }, - "requests": { - "type": "array", - "description": "", - "items": { - "$ref": "#/definitions/request" - } - }, - "events": { - "$ref": "#/definitions/event-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "id", - "name", - "order", - "requests" - ], - "definitions": { - "auth-attribute": { - "type": "object", - "title": "AuthAttribute", - "$id": "#/definitions/auth-attribute", - "description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.", - "properties": { - "key": { - "type": "string" - }, - "value": {}, - "type": { - "type": "string" - } - }, - "required": [ - "key" - ] - }, - "auth": { - "type": "object", - "title": "Auth", - "$id": "#/definitions/auth", - "description": "Represents authentication helpers provided by Postman", - "properties": { - "type": { - "type": "string", - "enum": [ - "apikey", - "awsv4", - "basic", - "bearer", - "digest", - "edgegrid", - "hawk", - "noauth", - "oauth1", - "oauth2", - "ntlm" - ] - }, - "noauth": {}, - "apikey": { - "type": "array", - "title": "API Key Authentication", - "description": "The attributes for API Key Authentication", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "awsv4": { - "type": "array", - "title": "AWS Signature v4", - "description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "basic": { - "type": "array", - "title": "Basic Authentication", - "description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "bearer": { - "type": "array", - "title": "Bearer Token Authentication", - "description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "digest": { - "type": "array", - "title": "Digest Authentication", - "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "edgegrid": { - "type": "array", - "title": "EdgeGrid Authentication", - "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "hawk": { - "type": "array", - "title": "Hawk Authentication", - "description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "ntlm": { - "type": "array", - "title": "NTLM Authentication", - "description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "oauth1": { - "type": "array", - "title": "OAuth1", - "description": "The attributes for [OAuth2](https://oauth.net/1/)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "oauth2": { - "type": "array", - "title": "OAuth2", - "description": "Helper attributes for [OAuth2](https://oauth.net/2/)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - } - }, - "required": [ - "type" - ] - }, - "current-helper": { - "$id": "#/definitions/current-helper", - "title": "Current auth helper", - "type": [ - "string", - "null" - ], - "description": "Postman can associate helpers with a request, which help with activities such as OAuth, Basic Authentication, etc. The type of helper associated with this request is stored in this field." - }, - "description": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/description", - "description": "A Description can be a raw text, or be an object, which holds the description along with its format.", - "oneOf": [ - { - "type": "object", - "title": "Description", - "properties": { - "content": { - "type": "string", - "description": "The content of the description goes here, as a raw string." - }, - "type": { - "type": "string", - "description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app." - }, - "version": { - "description": "Description can have versions associated with it, which should be put in this property." - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "event-list": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/event-list", - "title": "Event List", - "description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.", - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/event" - } - }, - { - "type": "null" - } - ] - }, - "event": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/event", - "title": "Event", - "description": "Defines a script associated with an associated event name", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for the enclosing event." - }, - "listen": { - "type": "string", - "description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively." - }, - "script": { - "$ref": "#/definitions/script" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled." - } - }, - "required": [ - "listen" - ] - }, - "folder": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/folder", - "title": "Folder", - "description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "In order to be able to uniquely identify different folders within a collection, Postman assigns each folder a unique ID (a [UUID](https://en.wikipedia.org/wiki/Globally_unique_identifier)). This field contains that value." - }, - "name": { - "type": "string", - "description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder." - }, - "description": { - "type": "string", - "description": "Essays about the folder go into this field!" - }, - "order": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "description": "Postman preserves the order of your requests within each folder. This field holds a sequence of [UUIDs](https://en.wikipedia.org/wiki/Globally_unique_identifier), where each ID corresponds to a particular Postman request." - }, - "folders_order": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "description": "Postman preserves the order of your folders within each folder. This field holds a sequence of [UUIDs](https://en.wikipedia.org/wiki/Globally_unique_identifier), where each ID corresponds to a particular collection folder." - }, - "collection_id": { - "type": "string", - "description": "Postman folders are always a part of a collection. That collection's unique ID (which is a [UUID](https://en.wikipedia.org/wiki/Globally_unique_identifier)) is stored in this field." - }, - "collection": { - "type": "string", - "description": "Postman folders are always a part of a collection. That collection's unique ID (which is a [UUID](https://en.wikipedia.org/wiki/Globally_unique_identifier)) is stored in this field." - }, - "variables": { - "$ref": "#/definitions/variable-list" - }, - "events": { - "$ref": "#/definitions/event-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "id", - "name", - "description", - "order" - ] - }, - "helper-attributes": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/helper-attributes", - "description": "A helper may require a number of parameters to actually be helpful. The parameters used by the helper can be stored in this field, as an object. E.g when using Basic Authentication, the username and password will be stored here.", - "oneOf": [ - { - "type": "null" - }, - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "properties": {} - }, - { - "type": "object", - "title": "API Key Authentication", - "description": "The attributes for API Key Authentication. e.g. key, value, in.", - "properties": { - "id": { - "type": "string", - "enum": [ - "apikey" - ], - "description": "This field contains the type of the helper. In this case, it is ``apikey``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "AWS Signature v4", - "description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). e.g. accessKey, secretKey, region, service.", - "properties": { - "id": { - "type": "string", - "const": "awsSigV4", - "description": "This field contains the type of the helper. In this case, it is ``awsSigV4``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "Digest Authentication", - "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). e.g. username, password, realm, nonce, nonceCount, algorithm, qop, opaque, clientNonce.", - "properties": { - "id": { - "type": "string", - "const": "digest", - "description": "This field contains the type of the helper. In this case, it is ``digest``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "EdgeGrid Authentication", - "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign.", - "properties": { - "id": { - "type": "string", - "const": "edgegrid", - "description": "This field contains the type of the helper. In this case, it is ``edgegrid``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "Hawk Authentication", - "description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk). e.g. authId, authKey, algorith, user, nonce, extraData, appId, delegation, timestamp.", - "properties": { - "id": { - "type": "string", - "const": "hawk", - "description": "This field contains the type of the Postman helper. In this case, it is ``hawk``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "NTLM Authentication", - "description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx). e.g. username, password, domain, workstation.", - "properties": { - "id": { - "type": "string", - "const": "ntlm", - "description": "This field contains the type of the helper. In this case, it is ``ntlm``" - } - }, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "Basic Authentication", - "description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). e.g. username, password.", - "properties": { - "id": { - "type": "string", - "const": "basic", - "description": "This field contains the type of the helper. In this case, it is ``basic``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "Bearer Token Authentication", - "description": "The attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750). e.g. token.", - "properties": { - "id": { - "type": "string", - "const": "bearer", - "description": "This field contains the type of the helper. In this case, it is ``bearer``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "OAuth1", - "description": "The attributes for [OAuth1](https://oauth.net/1/). e.g. consumerKey, consumerSecret, token, tokenSecret, signatureMethod, timestamp, nonce, version, realm, encodeOAuthSign.", - "properties": { - "id": { - "type": "string", - "const": "oAuth1", - "description": "This field contains the type of the helper. In this case, it is ``oAuth1``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - }, - { - "type": "object", - "title": "OAuth2", - "description": "The attributes for [OAuth2](https://oauth.net/2/). e.g. accessToken, addTokenTo.", - "properties": { - "id": { - "type": "string", - "const": "oAuth2", - "description": "This field contains the type of the helper. In this case, it is ``oAuth2``" - } - }, - "additionalProperties": true, - "required": [ - "id" - ] - } - ] - }, - "preRequestScript": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/preRequestScript", - "type": [ - "string", - "null" - ], - "description": "In some use cases, it's necessary to run a bit of code or perform some tasks before sending a request. Postman implements this feature by the use of this field. Any code written to this field is run before running a request." - }, - "protocol-profile-behavior": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Protocol Profile Behavior", - "$id": "#/definitions/protocol-profile-behavior", - "description": "Set of configurations used to alter the usual behavior of sending the request" - }, - "request": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/request", - "title": "Request", - "description": "A request represents an HTTP request.", - "type": "object", - "properties": { - "folder": { - "type": [ - "string", - "null" - ], - "description": "Postman requests may or may not be a part of a folder. If this request belongs to a folder, that folder's unique ID (which is a [UUID](https://en.wikipedia.org/wiki/Globally_unique_identifier)) is stored in this field." - }, - "id": { - "type": "string", - "description": "Postman can store a number of requests in each collection. In order to preserve the order of each request, we need to be able to identify requests uniquely. This field is a UUID assigned to each request." - }, - "name": { - "type": "string", - "description": "Sometimes, you just need to call your request 'Bob'. Postman will let you do that, and store the name you give in this field." - }, - "dataMode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "raw", - "urlencoded", - "params", - "binary", - "graphql" - ], - "description": "A request can have a specific data mode, and Postman supports these." - }, - { - "type": "null" - } - ] - }, - "dataOptions": { - "type": "object", - "description": "Additional configurations and options set for various body modes." - }, - "dataDisabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents request body from being sent." - }, - "data": { - "oneOf": [ - { - "type": "array", - "description": "Data is an array of key-values that the request goes with. POST data, PUT data, etc goes here.", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "description": { - "type": "string" - }, - "value": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "type": { - "const": "text" - } - } - }, - { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "description": { - "type": "string" - }, - "value": { - "type": [ - "null", - "string", - "array" - ] - }, - "enabled": { - "type": "boolean" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "type": { - "const": "file" - } - } - } - ] - } - }, - { - "type": "null" - } - ] - }, - "descriptionFormat": { - "type": [ - "string", - "null" - ], - "enum": [ - "html", - "markdown", - null - ], - "description": "A request can have an associated description text. Since description is meant to be long, it can be in either ``html`` or ``markdown`` formats. This field specifies that format." - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "The description of this request. Can be as long as you want. Postman also supports two formats for your description, ``markdown`` and ``html``." - }, - "headers": { - "type": "string", - "description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field contains all the HTTP Headers in a raw string format." - }, - "method": { - "anyOf": [ - { - "description": "The Standard HTTP method associated with this request.", - "type": "string", - "enum": [ - "GET", - "PUT", - "POST", - "PATCH", - "DELETE", - "COPY", - "HEAD", - "OPTIONS", - "LINK", - "UNLINK", - "PURGE", - "LOCK", - "UNLOCK", - "PROPFIND", - "VIEW" - ] - }, - { - "description": "The Custom HTTP method associated with this request.", - "type": "string" - } - ] - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "currentHelper": { - "$ref": "#/definitions/current-helper" - }, - "helperAttributes": { - "$ref": "#/definitions/helper-attributes" - }, - "pathVariables": { - "type": [ - "string", - "object", - "null" - ], - "description": "A Postman request allows you to use Path Variables in a request, e.g: ``/search/:bookId``. This field stores these variables." - }, - "url": { - "type": "string", - "description": "Contains the complete URL for this request, along with the path variables, if any." - }, - "events": { - "$ref": "#/definitions/event-list" - }, - "preRequestScript": { - "$ref": "#/definitions/preRequestScript" - }, - "tests": { - "$ref": "#/definitions/tests" - }, - "variables": { - "$ref": "#/definitions/variable-list" - }, - "time": { - "type": "number", - "multipleOf": 1, - "description": "The timestamp for this request." - }, - "responses": { - "type": "array", - "description": "A Postman request can have multiple responses associated with it. These responses are stored in this field.", - "items": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "response", - "title": "Response", - "description": "A response represents an HTTP response.", - "properties": { - "request": { - "type": [ - "string", - "object", - "null" - ], - "description": "A response is associated with a request. This fields contains the UUID of the request corresponding to this response." - }, - "id": { - "type": "string", - "description": "In order to unambiguously identify a response, Postman assigns a UUID to it, and stores it in this field." - }, - "name": { - "type": "string", - "description": "A response can have a friendly name, which goes here." - }, - "status": { - "type": "string", - "description": "" - }, - "responseCode": { - "type": "object", - "title": "ResponseCode", - "properties": { - "code": { - "type": "number", - "description": "The numeric HTTP response code." - }, - "name": { - "type": "string", - "description": "The textual HTTP response code." - }, - "detail": { - "type": "string", - "description": "Detailed explanation of the response code." - } - }, - "required": [ - "code", - "name" - ] - }, - "time": { - "type": [ - "null", - "string", - "number" - ], - "description": "The time taken by this particular HTTP transaction to complete is stored in this field. For manually created responses, this field can be set to ``null``." - }, - "timings": { - "title": "Response Timings", - "description": "Set of timing information related to request and response in milliseconds", - "type": [ - "object", - "null" - ] - }, - "headers": { - "type": "array", - "title": "Header", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Some headers can have names associated with them, which are stored in this field." - }, - "key": { - "type": "string", - "description": "The left hand side (LHS) or 'key' of the header." - }, - "value": { - "type": "string", - "description": "Value of the header, or the right hand side (RHS)." - }, - "description": { - "type": "string", - "description": "An optional description about the header." - } - }, - "required": [ - "key", - "value" - ] - } - }, - "cookies": { - "type": "array", - "title": "Cookie", - "items": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "The domain for which this cookie is valid." - }, - "expirationDate": { - "type": "number", - "description": "The timestamp of the time when the cookie expires." - }, - "hostOnly": { - "type": "boolean", - "description": "Indicates if this cookie is Host Only." - }, - "httpOnly": { - "type": "boolean", - "description": "Indicates if this cookie is HTTP Only." - }, - "name": { - "type": "string", - "description": "This is the name of the Cookie." - }, - "path": { - "type": "string", - "description": "The path associated with the Cookie." - }, - "secure": { - "type": "boolean", - "description": "Indicates if the 'secure' flag is set on the Cookie." - }, - "session": { - "type": "boolean", - "description": "True if the cookie is a session cookie." - }, - "storeId": { - "type": "string", - "description": "The ID of the cookie store containing this cookie." - }, - "value": { - "type": "string", - "description": "The value of the Cookie." - }, - "expires": { - "type": "string", - "description": "Human readable expiration time." - } - }, - "required": [ - "domain", - "expirationDate", - "hostOnly", - "httpOnly", - "name", - "path", - "secure", - "session", - "storeId", - "value", - "expires" - ] - } - }, - "mime": { - "type": "string", - "description": "Mimetype of the response." - }, - "text": { - "type": [ - "null", - "string" - ], - "description": "The raw text of the response." - }, - "language": { - "type": "string", - "enum": [ - "html", - "javascript", - "xml", - "Text" - ], - "description": "The language associated with the response." - }, - "rawDataType": { - "type": "string", - "description": "The data type of the raw response." - } - }, - "required": [ - "id", - "responseCode", - "request" - ] - } - }, - "rawModeData": { - "type": [ - "string", - "null", - "array" - ], - "description": "Contains the raw data (parameters) that Postman sends to the server" - }, - "graphqlModeData": { - "type": "object", - "description": "This field contains the GraphQL request body" - }, - "collectionId": { - "type": "string", - "description": "This field contains the unique ID of the collection to which this request belongs." - }, - "collection": { - "type": "string", - "description": "This field contains the unique ID of the collection to which this request belongs." - }, - "queryParams": { - "type": "array", - "items": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "urlparam", - "title": "UrlParam", - "description": "A response represents an HTTP response.", - "properties": { - "key": { - "type": [ - "string", - "null" - ], - "description": "The key of a URL parameter." - }, - "value": { - "type": [ - "string", - "null" - ], - "description": "The value of a URL parameter" - }, - "description": { - "type": "string", - "description": "You can associate descriptions with URL parameters, which are stored in this field." - } - } - } - }, - "headerData": { - "type": "array", - "items": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "header", - "title": "Header", - "description": "A response represents an HTTP response.", - "properties": { - "key": { - "type": "string", - "description": "Name of the header goes here. e.g: `Content-Type`" - }, - "value": { - "type": "string", - "description": "The value of the header" - }, - "description": { - "type": "string", - "description": "You can associate descriptions with headers too." - } - } - } - }, - "pathVariableData": { - "type": "array", - "items": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "pathvariable", - "title": "PathVariable", - "description": "A request URL may contain one or more path variables (e.g: `:varname`)", - "properties": { - "key": { - "type": "string", - "description": "The identifier of a path variable goes here." - }, - "value": { - "type": "string", - "description": "The value of the path variable will be substituted in place of the key." - }, - "description": { - "type": "string", - "description": "Extra description about a path variable may be added in this field." - } - } - } - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - }, - "responses_order": { - "type": "array", - "items": { - "type": "string" - }, - "uniqueItems": true, - "description": "Postman preserves the order of your responses within each request. This field holds a sequence of [UUIDs](https://en.wikipedia.org/wiki/Globally_unique_identifier), where each ID corresponds to a particular response." - } - }, - "anyOf": [ - { - "required": [ - "id", - "method", - "url", - "headers", - "name", - "collectionId" - ] - }, - { - "required": [ - "id", - "method", - "url", - "headers", - "name", - "collection" - ] - } - ] - }, - "script": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/script", - "title": "Script", - "type": "object", - "description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.", - "properties": { - "id": { - "description": "A unique, user defined identifier that can be used to refer to this script from requests.", - "type": "string" - }, - "type": { - "description": "Type of the script. E.g: 'text/javascript'", - "type": "string" - }, - "exec": { - "oneOf": [ - { - "type": "array", - "description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "src": { - "$ref": "#/definitions/url" - }, - "name": { - "type": "string", - "description": "Script name" - } - } - }, - "tests": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/tests", - "type": [ - "string", - "null" - ], - "description": "Postman allows you to define a script that is run after executing the request, which may act on the response. Such a script is stored in this field." - }, - "url": { - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.", - "$id": "#/definitions/url", - "title": "Url", - "oneOf": [ - { - "type": "object", - "properties": { - "raw": { - "type": "string", - "description": "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s)." - }, - "protocol": { - "type": "string", - "description": "The protocol associated with the request, E.g: 'http'" - }, - "host": { - "title": "Host", - "description": "The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - }, - "description": "The host, split into subdomain strings." - } - ] - }, - "path": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "description": "The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - ] - } - } - ] - }, - "port": { - "type": "string", - "description": "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https." - }, - "query": { - "type": "array", - "description": "An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables", - "items": { - "type": "object", - "title": "QueryParam", - "properties": { - "key": { - "type": [ - "string", - "null" - ] - }, - "value": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "If set to true, the current query parameter will not be sent with the request." - }, - "description": { - "$ref": "#/definitions/description" - } - } - } - }, - "hash": { - "description": "Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.", - "type": "string" - }, - "variable": { - "type": "array", - "description": "Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.", - "items": { - "$ref": "#/definitions/variable" - } - } - } - }, - { - "type": "string" - } - ] - }, - "variable-list": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable-list", - "title": "Variable List", - "description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*", - "type": "array", - "items": { - "$ref": "#/definitions/variable" - } - }, - "variable": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable", - "title": "Variable", - "description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.", - "type": "object", - "properties": { - "id": { - "description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "key": { - "description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "value": { - "description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection" - }, - "type": { - "description": "A variable may have multiple types. This field specifies the type of the variable.", - "type": "string", - "enum": [ - "string", - "boolean", - "any", - "number" - ] - }, - "name": { - "type": "string", - "description": "Variable name" - }, - "description": { - "$ref": "#/definitions/description" - }, - "system": { - "type": "boolean", - "default": false, - "description": "When set to true, indicates that this variable has been set by Postman" - }, - "disabled": { - "type": "boolean", - "default": false - } - }, - "anyOf": [ - { - "required": [ - "id" - ] - }, - { - "required": [ - "key" - ] - }, - { - "required": [ - "id", - "key" - ] - } - ] - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_0.json b/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_0.json deleted file mode 100644 index b075441de5..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_0.json +++ /dev/null @@ -1,1099 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://schema.getpostman.com/json/draft-07/collection/v2.0.0/", - "type": "object", - "properties": { - "info": { - "$ref": "#/definitions/info" - }, - "item": { - "type": "array", - "description": "Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.", - "items": { - "title": "Items", - "oneOf": [ - { - "$ref": "#/definitions/item" - }, - { - "$ref": "#/definitions/item-group" - } - ] - } - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "info", - "item" - ], - "definitions": { - "auth": { - "type": "object", - "title": "Auth", - "$id": "#/definitions/auth", - "description": "Represents authentication helpers provided by Postman", - "properties": { - "type": { - "type": "string", - "enum": [ - "apikey", - "awsv4", - "basic", - "bearer", - "digest", - "edgegrid", - "hawk", - "ntlm", - "noauth", - "oauth1", - "oauth2" - ] - }, - "noauth": {}, - "apikey": { - "type": "object", - "title": "API Key Authentication", - "description": "The attributes for API Key Authentication. e.g. key, value, in." - }, - "awsv4": { - "type": "object", - "title": "AWS Signature v4", - "description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). e.g. accessKey, secretKey, region, service." - }, - "basic": { - "type": "object", - "title": "Basic Authentication", - "description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). e.g. username, password." - }, - "bearer": { - "type": "object", - "title": "Bearer Token Authentication", - "description": "The attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750). e.g. token." - }, - "digest": { - "type": "object", - "title": "Digest Authentication", - "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). e.g. username, password, realm, nonce, nonceCount, algorithm, qop, opaque, clientNonce." - }, - "edgegrid": { - "type": "object", - "title": "EdgeGrid Authentication", - "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign." - }, - "hawk": { - "type": "object", - "title": "Hawk Authentication", - "description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk). e.g. authId, authKey, algorith, user, nonce, extraData, appId, delegation, timestamp." - }, - "ntlm": { - "type": "object", - "title": "NTLM Authentication", - "description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx). e.g. username, password, domain, workstation." - }, - "oauth1": { - "type": "object", - "title": "OAuth1", - "description": "The attributes for [OAuth1](https://oauth.net/1/). e.g. consumerKey, consumerSecret, token, tokenSecret, signatureMethod, timestamp, nonce, version, realm, encodeOAuthSign." - }, - "oauth2": { - "type": "object", - "title": "OAuth2", - "description": "The attributes for [OAuth2](https://oauth.net/2/). e.g. accessToken, addTokenTo." - } - }, - "required": [ - "type" - ] - }, - "certificate-list": { - "$id": "#/definitions/certificate-list", - "title": "Certificate List", - "description": "A representation of a list of ssl certificates", - "type": "array", - "items": { - "$ref": "#/definitions/certificate" - } - }, - "certificate": { - "$id": "#/definitions/certificate", - "title": "Certificate", - "description": "A representation of an ssl certificate", - "type": "object", - "properties": { - "name": { - "description": "A name for the certificate for user reference", - "type": "string" - }, - "matches": { - "description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.", - "type": "array", - "items": { - "type": "string", - "description": "An Url match pattern string" - } - }, - "key": { - "description": "An object containing path to file containing private key, on the file system", - "type": "object", - "properties": { - "src": { - "description": "The path to file containing key for certificate, on the file system" - } - } - }, - "cert": { - "description": "An object containing path to file certificate, on the file system", - "type": "object", - "properties": { - "src": { - "description": "The path to file containing key for certificate, on the file system" - } - } - }, - "passphrase": { - "description": "The passphrase for the certificate", - "type": "string" - } - } - }, - "cookie-list": { - "$id": "#/definitions/cookie-list", - "title": "Certificate List", - "description": "A representation of a list of cookies", - "type": "array", - "items": { - "$ref": "#/definitions/cookie" - } - }, - "cookie": { - "type": "object", - "title": "Cookie", - "$id": "#/definitions/cookie", - "description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)", - "properties": { - "domain": { - "type": "string", - "description": "The domain for which this cookie is valid." - }, - "expires": { - "type": [ - "string", - "null" - ], - "description": "When the cookie expires." - }, - "maxAge": { - "type": "string" - }, - "hostOnly": { - "type": "boolean", - "description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)." - }, - "httpOnly": { - "type": "boolean", - "description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)" - }, - "name": { - "type": "string", - "description": "This is the name of the Cookie." - }, - "path": { - "type": "string", - "description": "The path associated with the Cookie." - }, - "secure": { - "type": "boolean", - "description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)" - }, - "session": { - "type": "boolean", - "description": "True if the cookie is a session cookie." - }, - "value": { - "type": "string", - "description": "The value of the Cookie." - }, - "extensions": { - "type": "array", - "description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)" - } - }, - "required": [ - "domain", - "path" - ] - }, - "description": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/description", - "description": "A Description can be a raw text, or be an object, which holds the description along with its format.", - "oneOf": [ - { - "type": "object", - "title": "Description", - "properties": { - "content": { - "type": "string", - "description": "The content of the description goes here, as a raw string." - }, - "type": { - "type": "string", - "description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app." - }, - "version": { - "description": "Description can have versions associated with it, which should be put in this property." - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "event-list": { - "$id": "#/definitions/event-list", - "title": "Event List", - "type": "array", - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.", - "items": { - "$ref": "#/definitions/event" - } - }, - "event": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/event", - "title": "Event", - "description": "Defines a script associated with an associated event name", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for the enclosing event." - }, - "listen": { - "type": "string", - "description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively." - }, - "script": { - "$ref": "#/definitions/script" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled." - } - }, - "required": [ - "listen" - ] - }, - "header-list": { - "$id": "#/definitions/header-list", - "title": "Header List", - "description": "A representation for a list of headers", - "type": "array", - "items": { - "$ref": "#/definitions/header" - } - }, - "header": { - "type": "object", - "title": "Header", - "$id": "#/definitions/header", - "description": "Represents a single HTTP Header", - "properties": { - "key": { - "description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``", - "type": "string" - }, - "value": { - "type": "string", - "description": "The value (or the RHS) of the Header is stored in this field." - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "If set to true, the current header will not be sent with requests." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key", - "value" - ] - }, - "info": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/info", - "title": "Information", - "description": "Detailed description of the info block", - "type": "object", - "properties": { - "name": { - "type": "string", - "title": "Name of the collection", - "description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content." - }, - "_postman_id": { - "type": "string", - "description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.*" - }, - "description": { - "$ref": "#/definitions/description" - }, - "version": { - "$ref": "#/definitions/version" - }, - "schema": { - "description": "This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1", - "type": "string" - } - }, - "required": [ - "name", - "schema" - ] - }, - "item-group": { - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Folder", - "$id": "#/definitions/item-group", - "description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder." - }, - "description": { - "$ref": "#/definitions/description" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "item": { - "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.", - "type": "array", - "items": { - "title": "Items", - "anyOf": [ - { - "$ref": "#/definitions/item" - }, - { - "$ref": "#/definitions/item-group" - } - ] - } - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "item" - ] - }, - "item": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Item", - "$id": "#/definitions/item", - "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.", - "properties": { - "id": { - "type": "string", - "description": "A unique ID that is used to identify collections internally" - }, - "name": { - "type": "string", - "description": "A human readable identifier for the current item." - }, - "description": { - "$ref": "#/definitions/description" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "request": { - "$ref": "#/definitions/request" - }, - "response": { - "type": "array", - "title": "Responses", - "items": { - "$ref": "#/definitions/response" - } - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "request" - ] - }, - "protocol-profile-behavior": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Protocol Profile Behavior", - "$id": "#/definitions/protocol-profile-behavior", - "description": "Set of configurations used to alter the usual behavior of sending the request" - }, - "proxy-config": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/proxy-config", - "title": "Proxy Config", - "description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match", - "type": "object", - "properties": { - "match": { - "default": "http+https://*/*", - "description": "The Url match for which the proxy config is defined", - "type": "string" - }, - "host": { - "type": "string", - "description": "The proxy server host" - }, - "port": { - "type": "integer", - "minimum": 0, - "default": 8080, - "description": "The proxy server port" - }, - "tunnel": { - "description": "The tunneling details for the proxy config", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, ignores this proxy configuration entity" - } - } - }, - "request": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/request", - "title": "Request", - "description": "A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.", - "oneOf": [ - { - "type": "object", - "title": "Request", - "properties": { - "url": { - "$ref": "#/definitions/url" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "proxy": { - "$ref": "#/definitions/proxy-config" - }, - "certificate": { - "$ref": "#/definitions/certificate" - }, - "method": { - "anyOf": [ - { - "description": "The Standard HTTP method associated with this request.", - "type": "string", - "enum": [ - "GET", - "PUT", - "POST", - "PATCH", - "DELETE", - "COPY", - "HEAD", - "OPTIONS", - "LINK", - "UNLINK", - "PURGE", - "LOCK", - "UNLOCK", - "PROPFIND", - "VIEW" - ] - }, - { - "description": "The Custom HTTP method associated with this request.", - "type": "string" - } - ] - }, - "description": { - "$ref": "#/definitions/description" - }, - "header": { - "oneOf": [ - { - "$ref": "#/definitions/header-list" - }, - { - "type": "string" - } - ] - }, - "body": { - "oneOf": [ - { - "type": "object", - "description": "This field contains the data usually contained in the request body.", - "properties": { - "mode": { - "description": "Postman stores the type of data associated with this request in this field.", - "enum": [ - "raw", - "urlencoded", - "formdata", - "file", - "graphql" - ] - }, - "raw": { - "type": "string" - }, - "graphql": { - "type": "object" - }, - "urlencoded": { - "type": "array", - "items": { - "type": "object", - "title": "UrlEncodedParameter", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - }, - "disabled": { - "type": "boolean", - "default": false - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - } - }, - "formdata": { - "type": "array", - "items": { - "type": "object", - "title": "FormParameter", - "anyOf": [ - { - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents this form data entity from being sent." - }, - "type": { - "type": "string", - "const": "text" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - }, - { - "properties": { - "key": { - "type": "string" - }, - "src": { - "type": [ - "array", - "string", - "null" - ] - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents this form data entity from being sent." - }, - "type": { - "type": "string", - "const": "file" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - } - ] - } - }, - "file": { - "type": "object", - "properties": { - "src": { - "oneOf": [ - { - "type": "string", - "description": "Contains the name of the file to upload. _Not the path_." - }, - { - "type": "null", - "description": "A null src indicates that no file has been selected as a part of the request body" - } - ] - }, - "content": { - "type": "string" - } - } - }, - "options": { - "type": "object", - "description": "Additional configurations and options set for various body modes." - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents request body from being sent." - } - } - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "string" - } - ] - }, - "response": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/response", - "title": "Response", - "description": "A response represents an HTTP response.", - "properties": { - "id": { - "description": "A unique, user defined identifier that can be used to refer to this response from requests.", - "type": "string" - }, - "originalRequest": { - "$ref": "#/definitions/request" - }, - "responseTime": { - "title": "ResponseTime", - "description": "The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`.", - "type": [ - "null", - "string", - "number" - ] - }, - "timings": { - "title": "Response Timings", - "description": "Set of timing information related to request and response in milliseconds", - "type": [ - "object", - "null" - ] - }, - "header": { - "title": "Headers", - "oneOf": [ - { - "type": "array", - "title": "Header", - "description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/header" - }, - { - "title": "Header", - "type": "string" - } - ] - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "cookie": { - "type": "array", - "items": { - "$ref": "#/definitions/cookie" - } - }, - "body": { - "type": [ - "null", - "string" - ], - "description": "The raw text of the response." - }, - "status": { - "type": "string", - "description": "The response status, e.g: '200 OK'" - }, - "code": { - "type": "integer", - "description": "The numerical response code, example: 200, 201, 404, etc." - } - } - }, - "script": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/script", - "title": "Script", - "type": "object", - "description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.", - "properties": { - "id": { - "description": "A unique, user defined identifier that can be used to refer to this script from requests.", - "type": "string" - }, - "type": { - "description": "Type of the script. E.g: 'text/javascript'", - "type": "string" - }, - "exec": { - "oneOf": [ - { - "type": "array", - "description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "src": { - "$ref": "#/definitions/url" - }, - "name": { - "type": "string", - "description": "Script name" - } - } - }, - "url": { - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.", - "$id": "#/definitions/url", - "title": "Url", - "oneOf": [ - { - "type": "object", - "properties": { - "raw": { - "type": "string", - "description": "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s)." - }, - "protocol": { - "type": "string", - "description": "The protocol associated with the request, E.g: 'http'" - }, - "host": { - "title": "Host", - "description": "The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - }, - "description": "The host, split into subdomain strings." - } - ] - }, - "path": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "description": "The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - ] - } - } - ] - }, - "port": { - "type": "string", - "description": "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https." - }, - "query": { - "type": "array", - "description": "An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables", - "items": { - "type": "object", - "title": "QueryParam", - "properties": { - "key": { - "type": [ - "string", - "null" - ] - }, - "value": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "If set to true, the current query parameter will not be sent with the request." - }, - "description": { - "$ref": "#/definitions/description" - } - } - } - }, - "hash": { - "description": "Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.", - "type": "string" - }, - "variable": { - "type": "array", - "description": "Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.", - "items": { - "$ref": "#/definitions/variable" - } - } - } - }, - { - "type": "string" - } - ] - }, - "variable-list": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable-list", - "title": "Variable List", - "description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*", - "type": "array", - "items": { - "$ref": "#/definitions/variable" - } - }, - "variable": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable", - "title": "Variable", - "description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.", - "type": "object", - "properties": { - "id": { - "description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "key": { - "description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "value": { - "description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection" - }, - "type": { - "description": "A variable may have multiple types. This field specifies the type of the variable.", - "type": "string", - "enum": [ - "string", - "boolean", - "any", - "number" - ] - }, - "name": { - "type": "string", - "description": "Variable name" - }, - "description": { - "$ref": "#/definitions/description" - }, - "system": { - "type": "boolean", - "default": false, - "description": "When set to true, indicates that this variable has been set by Postman" - }, - "disabled": { - "type": "boolean", - "default": false - } - }, - "anyOf": [ - { - "required": [ - "id" - ] - }, - { - "required": [ - "key" - ] - }, - { - "required": [ - "id", - "key" - ] - } - ] - }, - "version": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/version", - "title": "Collection Version", - "description": "Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!", - "oneOf": [ - { - "type": "object", - "properties": { - "major": { - "description": "Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).", - "minimum": 0, - "type": "integer" - }, - "minor": { - "description": "You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.", - "minimum": 0, - "type": "integer" - }, - "patch": { - "description": "Ideally, minor changes to a collection should result in the increment of this number.", - "minimum": 0, - "type": "integer" - }, - "identifier": { - "description": "A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'", - "type": "string", - "maxLength": 10 - }, - "meta": {} - }, - "required": [ - "major", - "minor", - "patch" - ] - }, - { - "type": "string" - } - ] - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_1.json b/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_1.json deleted file mode 100644 index a7c05f60c1..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/postman-collection-2_1.json +++ /dev/null @@ -1,1146 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://schema.getpostman.com/json/draft-07/collection/v2.1.0/", - "type": "object", - "properties": { - "info": { - "$ref": "#/definitions/info" - }, - "item": { - "type": "array", - "description": "Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.", - "items": { - "title": "Items", - "oneOf": [ - { - "$ref": "#/definitions/item" - }, - { - "$ref": "#/definitions/item-group" - } - ] - } - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "info", - "item" - ], - "definitions": { - "auth-attribute": { - "type": "object", - "title": "AuthAttribute", - "$id": "#/definitions/auth-attribute", - "description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.", - "properties": { - "key": { - "type": "string" - }, - "value": {}, - "type": { - "type": "string" - } - }, - "required": [ - "key" - ] - }, - "auth": { - "type": "object", - "title": "Auth", - "$id": "#/definitions/auth", - "description": "Represents authentication helpers provided by Postman", - "properties": { - "type": { - "type": "string", - "enum": [ - "apikey", - "awsv4", - "basic", - "bearer", - "digest", - "edgegrid", - "hawk", - "noauth", - "oauth1", - "oauth2", - "ntlm" - ] - }, - "noauth": {}, - "apikey": { - "type": "array", - "title": "API Key Authentication", - "description": "The attributes for API Key Authentication.", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "awsv4": { - "type": "array", - "title": "AWS Signature v4", - "description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "basic": { - "type": "array", - "title": "Basic Authentication", - "description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "bearer": { - "type": "array", - "title": "Bearer Token Authentication", - "description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "digest": { - "type": "array", - "title": "Digest Authentication", - "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "edgegrid": { - "type": "array", - "title": "EdgeGrid Authentication", - "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "hawk": { - "type": "array", - "title": "Hawk Authentication", - "description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "ntlm": { - "type": "array", - "title": "NTLM Authentication", - "description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "oauth1": { - "type": "array", - "title": "OAuth1", - "description": "The attributes for [OAuth2](https://oauth.net/1/)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - }, - "oauth2": { - "type": "array", - "title": "OAuth2", - "description": "Helper attributes for [OAuth2](https://oauth.net/2/)", - "items": { - "$ref": "#/definitions/auth-attribute" - } - } - }, - "required": [ - "type" - ] - }, - "certificate-list": { - "$id": "#/definitions/certificate-list", - "title": "Certificate List", - "description": "A representation of a list of ssl certificates", - "type": "array", - "items": { - "$ref": "#/definitions/certificate" - } - }, - "certificate": { - "$id": "#/definitions/certificate", - "title": "Certificate", - "description": "A representation of an ssl certificate", - "type": "object", - "properties": { - "name": { - "description": "A name for the certificate for user reference", - "type": "string" - }, - "matches": { - "description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.", - "type": "array", - "items": { - "type": "string", - "description": "An Url match pattern string" - } - }, - "key": { - "description": "An object containing path to file containing private key, on the file system", - "type": "object", - "properties": { - "src": { - "description": "The path to file containing key for certificate, on the file system" - } - } - }, - "cert": { - "description": "An object containing path to file certificate, on the file system", - "type": "object", - "properties": { - "src": { - "description": "The path to file containing key for certificate, on the file system" - } - } - }, - "passphrase": { - "description": "The passphrase for the certificate", - "type": "string" - } - } - }, - "cookie-list": { - "$id": "#/definitions/cookie-list", - "title": "Certificate List", - "description": "A representation of a list of cookies", - "type": "array", - "items": { - "$ref": "#/definitions/cookie" - } - }, - "cookie": { - "type": "object", - "title": "Cookie", - "$id": "#/definitions/cookie", - "description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)", - "properties": { - "domain": { - "type": "string", - "description": "The domain for which this cookie is valid." - }, - "expires": { - "type": [ - "string", - "null" - ], - "description": "When the cookie expires." - }, - "maxAge": { - "type": "string" - }, - "hostOnly": { - "type": "boolean", - "description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)." - }, - "httpOnly": { - "type": "boolean", - "description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)" - }, - "name": { - "type": "string", - "description": "This is the name of the Cookie." - }, - "path": { - "type": "string", - "description": "The path associated with the Cookie." - }, - "secure": { - "type": "boolean", - "description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)" - }, - "session": { - "type": "boolean", - "description": "True if the cookie is a session cookie." - }, - "value": { - "type": "string", - "description": "The value of the Cookie." - }, - "extensions": { - "type": "array", - "description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)" - } - }, - "required": [ - "domain", - "path" - ] - }, - "description": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/description", - "description": "A Description can be a raw text, or be an object, which holds the description along with its format.", - "oneOf": [ - { - "type": "object", - "title": "Description", - "properties": { - "content": { - "type": "string", - "description": "The content of the description goes here, as a raw string." - }, - "type": { - "type": "string", - "description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app." - }, - "version": { - "description": "Description can have versions associated with it, which should be put in this property." - } - } - }, - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "event-list": { - "$id": "#/definitions/event-list", - "title": "Event List", - "type": "array", - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.", - "items": { - "$ref": "#/definitions/event" - } - }, - "event": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/event", - "title": "Event", - "description": "Defines a script associated with an associated event name", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for the enclosing event." - }, - "listen": { - "type": "string", - "description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively." - }, - "script": { - "$ref": "#/definitions/script" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled." - } - }, - "required": [ - "listen" - ] - }, - "header-list": { - "$id": "#/definitions/header-list", - "title": "Header List", - "description": "A representation for a list of headers", - "type": "array", - "items": { - "$ref": "#/definitions/header" - } - }, - "header": { - "type": "object", - "title": "Header", - "$id": "#/definitions/header", - "description": "Represents a single HTTP Header", - "properties": { - "key": { - "description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``", - "type": "string" - }, - "value": { - "type": "string", - "description": "The value (or the RHS) of the Header is stored in this field." - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "If set to true, the current header will not be sent with requests." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key", - "value" - ] - }, - "info": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/info", - "title": "Information", - "description": "Detailed description of the info block", - "type": "object", - "properties": { - "name": { - "type": "string", - "title": "Name of the collection", - "description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content." - }, - "_postman_id": { - "type": "string", - "description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.*" - }, - "description": { - "$ref": "#/definitions/description" - }, - "version": { - "$ref": "#/definitions/version" - }, - "schema": { - "description": "This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1", - "type": "string" - } - }, - "required": [ - "name", - "schema" - ] - }, - "item-group": { - "$schema": "http://json-schema.org/draft-07/schema#", - "title": "Folder", - "$id": "#/definitions/item-group", - "description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder." - }, - "description": { - "$ref": "#/definitions/description" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "item": { - "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.", - "type": "array", - "items": { - "title": "Items", - "anyOf": [ - { - "$ref": "#/definitions/item" - }, - { - "$ref": "#/definitions/item-group" - } - ] - } - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "item" - ] - }, - "item": { - "type": "object", - "title": "Item", - "$id": "#/definitions/item", - "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.", - "properties": { - "id": { - "type": "string", - "description": "A unique ID that is used to identify collections internally" - }, - "name": { - "type": "string", - "description": "A human readable identifier for the current item." - }, - "description": { - "$ref": "#/definitions/description" - }, - "variable": { - "$ref": "#/definitions/variable-list" - }, - "event": { - "$ref": "#/definitions/event-list" - }, - "request": { - "$ref": "#/definitions/request" - }, - "response": { - "type": "array", - "title": "Responses", - "items": { - "$ref": "#/definitions/response" - } - }, - "protocolProfileBehavior": { - "$ref": "#/definitions/protocol-profile-behavior" - } - }, - "required": [ - "request" - ] - }, - "protocol-profile-behavior": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "title": "Protocol Profile Behavior", - "$id": "#/definitions/protocol-profile-behavior", - "description": "Set of configurations used to alter the usual behavior of sending the request" - }, - "proxy-config": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/proxy-config", - "title": "Proxy Config", - "description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match", - "type": "object", - "properties": { - "match": { - "default": "http+https://*/*", - "description": "The Url match for which the proxy config is defined", - "type": "string" - }, - "host": { - "type": "string", - "description": "The proxy server host" - }, - "port": { - "type": "integer", - "minimum": 0, - "default": 8080, - "description": "The proxy server port" - }, - "tunnel": { - "description": "The tunneling details for the proxy config", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, ignores this proxy configuration entity" - } - } - }, - "request": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/request", - "title": "Request", - "description": "A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.", - "oneOf": [ - { - "type": "object", - "title": "Request", - "properties": { - "url": { - "$ref": "#/definitions/url" - }, - "auth": { - "oneOf": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/auth" - } - ] - }, - "proxy": { - "$ref": "#/definitions/proxy-config" - }, - "certificate": { - "$ref": "#/definitions/certificate" - }, - "method": { - "anyOf": [ - { - "description": "The Standard HTTP method associated with this request.", - "type": "string", - "enum": [ - "GET", - "PUT", - "POST", - "PATCH", - "DELETE", - "COPY", - "HEAD", - "OPTIONS", - "LINK", - "UNLINK", - "PURGE", - "LOCK", - "UNLOCK", - "PROPFIND", - "VIEW" - ] - }, - { - "description": "The Custom HTTP method associated with this request.", - "type": "string" - } - ] - }, - "description": { - "$ref": "#/definitions/description" - }, - "header": { - "oneOf": [ - { - "$ref": "#/definitions/header-list" - }, - { - "type": "string" - } - ] - }, - "body": { - "oneOf": [ - { - "type": "object", - "description": "This field contains the data usually contained in the request body.", - "properties": { - "mode": { - "description": "Postman stores the type of data associated with this request in this field.", - "enum": [ - "raw", - "urlencoded", - "formdata", - "file", - "graphql" - ] - }, - "raw": { - "type": "string" - }, - "graphql": { - "type": "object" - }, - "urlencoded": { - "type": "array", - "items": { - "type": "object", - "title": "UrlEncodedParameter", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - }, - "disabled": { - "type": "boolean", - "default": false - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - } - }, - "formdata": { - "type": "array", - "items": { - "type": "object", - "title": "FormParameter", - "anyOf": [ - { - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents this form data entity from being sent." - }, - "type": { - "type": "string", - "const": "text" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - }, - { - "properties": { - "key": { - "type": "string" - }, - "src": { - "type": [ - "array", - "string", - "null" - ] - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents this form data entity from being sent." - }, - "type": { - "type": "string", - "const": "file" - }, - "contentType": { - "type": "string", - "description": "Override Content-Type header of this form data entity." - }, - "description": { - "$ref": "#/definitions/description" - } - }, - "required": [ - "key" - ] - } - ] - } - }, - "file": { - "type": "object", - "properties": { - "src": { - "oneOf": [ - { - "type": "string", - "description": "Contains the name of the file to upload. _Not the path_." - }, - { - "type": "null", - "description": "A null src indicates that no file has been selected as a part of the request body" - } - ] - }, - "content": { - "type": "string" - } - } - }, - "options": { - "type": "object", - "description": "Additional configurations and options set for various body modes." - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "When set to true, prevents request body from being sent." - } - } - }, - { - "type": "null" - } - ] - } - } - }, - { - "type": "string" - } - ] - }, - "response": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/response", - "title": "Response", - "description": "A response represents an HTTP response.", - "properties": { - "id": { - "description": "A unique, user defined identifier that can be used to refer to this response from requests.", - "type": "string" - }, - "originalRequest": { - "$ref": "#/definitions/request" - }, - "responseTime": { - "title": "ResponseTime", - "type": [ - "null", - "string", - "number" - ], - "description": "The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`." - }, - "timings": { - "title": "Response Timings", - "description": "Set of timing information related to request and response in milliseconds", - "type": [ - "object", - "null" - ] - }, - "header": { - "title": "Headers", - "oneOf": [ - { - "type": "array", - "title": "Header", - "description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/header" - }, - { - "title": "Header", - "type": "string" - } - ] - } - }, - { - "type": [ - "string", - "null" - ] - } - ] - }, - "cookie": { - "type": "array", - "items": { - "$ref": "#/definitions/cookie" - } - }, - "body": { - "type": [ - "null", - "string" - ], - "description": "The raw text of the response." - }, - "status": { - "type": "string", - "description": "The response status, e.g: '200 OK'" - }, - "code": { - "type": "integer", - "description": "The numerical response code, example: 200, 201, 404, etc." - } - } - }, - "script": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/script", - "title": "Script", - "type": "object", - "description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.", - "properties": { - "id": { - "description": "A unique, user defined identifier that can be used to refer to this script from requests.", - "type": "string" - }, - "type": { - "description": "Type of the script. E.g: 'text/javascript'", - "type": "string" - }, - "exec": { - "oneOf": [ - { - "type": "array", - "description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "src": { - "$ref": "#/definitions/url" - }, - "name": { - "type": "string", - "description": "Script name" - } - } - }, - "url": { - "$schema": "http://json-schema.org/draft-07/schema#", - "description": "If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.", - "$id": "#/definitions/url", - "title": "Url", - "oneOf": [ - { - "type": "object", - "properties": { - "raw": { - "type": "string", - "description": "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s)." - }, - "protocol": { - "type": "string", - "description": "The protocol associated with the request, E.g: 'http'" - }, - "host": { - "title": "Host", - "description": "The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - }, - "description": "The host, split into subdomain strings." - } - ] - }, - "path": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "description": "The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - ] - } - } - ] - }, - "port": { - "type": "string", - "description": "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https." - }, - "query": { - "type": "array", - "description": "An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables", - "items": { - "type": "object", - "title": "QueryParam", - "properties": { - "key": { - "type": [ - "string", - "null" - ] - }, - "value": { - "type": [ - "string", - "null" - ] - }, - "disabled": { - "type": "boolean", - "default": false, - "description": "If set to true, the current query parameter will not be sent with the request." - }, - "description": { - "$ref": "#/definitions/description" - } - } - } - }, - "hash": { - "description": "Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.", - "type": "string" - }, - "variable": { - "type": "array", - "description": "Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.", - "items": { - "$ref": "#/definitions/variable" - } - } - } - }, - { - "type": "string" - } - ] - }, - "variable-list": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable-list", - "title": "Variable List", - "description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*", - "type": "array", - "items": { - "$ref": "#/definitions/variable" - } - }, - "variable": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/variable", - "title": "Variable", - "description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.", - "type": "object", - "properties": { - "id": { - "description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "key": { - "description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.", - "type": "string" - }, - "value": { - "description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection" - }, - "type": { - "description": "A variable may have multiple types. This field specifies the type of the variable.", - "type": "string", - "enum": [ - "string", - "boolean", - "any", - "number" - ] - }, - "name": { - "type": "string", - "description": "Variable name" - }, - "description": { - "$ref": "#/definitions/description" - }, - "system": { - "type": "boolean", - "default": false, - "description": "When set to true, indicates that this variable has been set by Postman" - }, - "disabled": { - "type": "boolean", - "default": false - } - }, - "anyOf": [ - { - "required": [ - "id" - ] - }, - { - "required": [ - "key" - ] - }, - { - "required": [ - "id", - "key" - ] - } - ] - }, - "version": { - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "#/definitions/version", - "title": "Collection Version", - "description": "Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!", - "oneOf": [ - { - "type": "object", - "properties": { - "major": { - "description": "Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).", - "minimum": 0, - "type": "integer" - }, - "minor": { - "description": "You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.", - "minimum": 0, - "type": "integer" - }, - "patch": { - "description": "Ideally, minor changes to a collection should result in the increment of this number.", - "minimum": 0, - "type": "integer" - }, - "identifier": { - "description": "A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'", - "type": "string", - "maxLength": 10 - }, - "meta": {} - }, - "required": [ - "major", - "minor", - "patch" - ] - }, - { - "type": "string" - } - ] - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/prometheus-config.json b/test/blackbox/docs/JsonSchemaDraft-7/prometheus-config.json deleted file mode 100644 index b355e0f2f7..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/prometheus-config.json +++ /dev/null @@ -1,927 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://json.schemastore.org/prometheus", - "title": "Prometheus", - "description": "Prometheus configuration file", - "type": [ - "object", - "null" - ], - "properties": { - "global": { - "description": "The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections.", - "type": [ - "object", - "null" - ], - "properties": { - "scrape_interval": { - "description": "How frequently to scrape targets by default.", - "$ref": "#/definitions/duration", - "default": "1m" - }, - "scrape_timeout": { - "description": "How long until a scrape request times out.", - "$ref": "#/definitions/duration", - "default": "10s" - }, - "evaluation_interval": { - "description": "How frequently to evaluate rules.", - "$ref": "#/definitions/duration", - "default": "1m" - }, - "external_labels": { - "description": "The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager).", - "$ref": "#/definitions/labels" - } - }, - "additionalProperties": false - }, - "rule_files": { - "description": "Rule files specifies a list of globs. Rules and alerts are read from all matching files.", - "type": [ - "array", - "null" - ], - "items": { - "$ref": "#/definitions/filepath_glob" - } - }, - "remote_write": { - "description": "Settings related to the remote write feature.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "url": { - "description": "The URL of the endpoint to send samples to.", - "type": "string", - "format": "uri-reference" - }, - "remote_timeout": { - "description": "Timeout for requests to the remote write endpoint.", - "$ref": "#/definitions/duration", - "default": "30s" - }, - "write_relabel_configs": { - "description": "List of remote write relabel configurations.", - "$ref": "#/definitions/relabel_configs" - }, - "basic_auth": { - "$ref": "#/definitions/basic_auth" - }, - "bearer_token": { - "$ref": "#/definitions/bearer_token" - }, - "bearer_token_file": { - "$ref": "#/definitions/bearer_token_file" - }, - "tls_config": { - "description": "Configures the remote write request's TLS settings.", - "$ref": "#/definitions/tls_config" - }, - "proxy_url": { - "description": "Optional proxy URL.", - "type": [ - "string", - "null" - ], - "format": "uri-reference" - }, - "queue_config": { - "description": "Configures the queue used to write to remote storage.", - "type": [ - "object", - "null" - ], - "properties": { - "capacity": { - "description": "Number of samples to buffer per shard before we block reading of more samples from the WAL. It is recommended to have enough capacity in each shard to buffer several requests to keep throughput up while processing occasional slow remote requests.", - "type": [ - "integer", - "null" - ], - "default": 500 - }, - "max_shards": { - "description": "Maximum number of shards, i.e. amount of concurrency.", - "type": [ - "integer", - "null" - ], - "default": 1000 - }, - "min_shards": { - "description": "Minimum number of shards, i.e. amount of concurrency.", - "type": [ - "integer", - "null" - ], - "default": 1 - }, - "max_samples_per_send": { - "description": "Maximum number of samples per send.", - "type": [ - "integer", - "null" - ], - "default": 100 - }, - "batch_send_deadline": { - "description": "Maximum time a sample will wait in buffer.", - "$ref": "#/definitions/duration", - "default": "5s" - }, - "min_backoff": { - "description": "Initial retry delay. Gets doubled for every retry.", - "$ref": "#/definitions/duration", - "default": "30ms" - }, - "max_backoff": { - "description": "Maximum retry delay.", - "$ref": "#/definitions/duration", - "default": "100ms" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/auth" - } - ], - "additionalProperties": false, - "required": [ - "url" - ] - } - }, - "remote_read": { - "description": "Settings related to the remote read feature.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "url": { - "description": "The URL of the endpoint to query from.", - "type": "string", - "format": "uri-reference" - }, - "required_matchers": { - "description": "An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.", - "$ref": "#/definitions/labels" - }, - "remote_timeout": { - "description": "Timeout for requests to the remote read endpoint.", - "$ref": "#/definitions/duration", - "default": "1m" - }, - "read_recent": { - "description": "Whether reads should be made for queries for time ranges that the local storage should have complete data for.", - "type": [ - "boolean", - "null" - ], - "default": false - }, - "basic_auth": { - "$ref": "#/definitions/basic_auth" - }, - "bearer_token": { - "$ref": "#/definitions/bearer_token" - }, - "bearer_token_file": { - "$ref": "#/definitions/bearer_token_file" - }, - "tls_config": { - "$ref": "#/definitions/tls_config" - }, - "proxy_url": { - "description": "Optional proxy URL.", - "type": [ - "string", - "null" - ], - "format": "uri-reference" - } - }, - "allOf": [ - { - "$ref": "#/definitions/auth" - } - ], - "additionalProperties": false, - "required": [ - "url" - ] - } - }, - "scrape_configs": { - "description": "A list of scrape configurations.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "job_name": { - "description": "The job name assigned to scraped metrics by default. Must be unique across all scrape configurations.", - "type": "string" - }, - "scrape_interval": { - "description": "How frequently to scrape targets from this job. Defaults to `global.scrape_interval`.", - "$ref": "#/definitions/duration" - }, - "scrape_timeout": { - "description": "Per-scrape timeout when scraping this job. Defaults to `global.scrape_timeout`.", - "$ref": "#/definitions/duration" - }, - "metrics_path": { - "description": "The HTTP resource path on which to fetch metrics from targets.", - "type": [ - "string", - "null" - ], - "default": "/metrics" - }, - "honor_labels": { - "description": "Controls how Prometheus handles conflicts between labels that are already present in scraped data and labels that Prometheus would attach server-side (\"job\" and \"instance\" labels, manually configured target labels, and labels generated by service discovery implementations).", - "type": [ - "boolean", - "null" - ], - "default": false - }, - "honor_timestamps": { - "description": "Controls whether Prometheus respects the timestamps present in scraped data.", - "type": [ - "boolean", - "null" - ], - "default": true - }, - "scheme": { - "description": "Configures the protocol scheme used for requests.", - "$ref": "#/definitions/scheme" - }, - "params": { - "description": "Optional HTTP(S) URL parameters.", - "type": [ - "object", - "null" - ], - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "basic_auth": { - "$ref": "#/definitions/basic_auth" - }, - "bearer_token": { - "$ref": "#/definitions/bearer_token" - }, - "bearer_token_file": { - "$ref": "#/definitions/bearer_token_file" - }, - "tls_config": { - "description": "Configures the scrape request's TLS settings.", - "$ref": "#/definitions/tls_config" - }, - "proxy_url": { - "description": "Optional proxy URL.", - "type": [ - "string", - "null" - ], - "format": "uri-reference" - }, - "azure_sd_configs": { - "$ref": "#/definitions/azure_sd_configs" - }, - "consul_sd_configs": { - "$ref": "#/definitions/consul_sd_configs" - }, - "dns_sd_configs": { - "$ref": "#/definitions/dns_sd_configs" - }, - "ec2_sd_configs": { - "$ref": "#/definitions/ec2_sd_configs" - }, - "openstack_sd_configs": { - "$ref": "#/definitions/openstack_sd_configs" - }, - "file_sd_configs": { - "$ref": "#/definitions/file_sd_configs" - }, - "gce_sd_configs": { - "$ref": "#/definitions/gce_sd_configs" - }, - "kubernetes_sd_configs": { - "$ref": "#/definitions/kubernetes_sd_configs" - }, - "marathon_sd_configs": { - "$ref": "#/definitions/marathon_sd_configs" - }, - "nerve_sd_configs": { - "$ref": "#/definitions/nerve_sd_configs" - }, - "serverset_sd_configs": { - "$ref": "#/definitions/serverset_sd_configs" - }, - "triton_sd_configs": { - "$ref": "#/definitions/triton_sd_configs" - }, - "static_configs": { - "$ref": "#/definitions/static_configs" - }, - "relabel_configs": { - "description": "List of target relabel configurations.", - "$ref": "#/definitions/relabel_configs" - }, - "metric_relabel_configs": { - "description": "List of metric relabel configurations.", - "$ref": "#/definitions/relabel_configs" - }, - "sample_limit": { - "description": "Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabelling the entire scrape will be treated as failed. 0 means no limit.", - "type": [ - "integer", - "null" - ], - "default": 0 - } - }, - "allOf": [ - { - "$ref": "#/definitions/auth" - } - ], - "additionalProperties": false, - "required": [ - "job_name" - ] - } - }, - "alerting": { - "description": "Alerting specifies settings related to the Alertmanager.", - "type": [ - "object", - "null" - ], - "properties": { - "alert_relabel_configs": { - "$ref": "#/definitions/relabel_configs" - }, - "alertmanagers": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "timeout": { - "description": "Per-target Alertmanager timeout when pushing alerts.", - "$ref": "#/definitions/duration", - "default": "10s" - }, - "api_version": { - "description": "The api version of Alertmanager.", - "type": [ - "string", - "null" - ], - "default": "v1" - }, - "path_prefix": { - "description": "Prefix for the HTTP path alerts are pushed to.", - "type": [ - "string", - "null" - ], - "default": "/" - }, - "scheme": { - "description": "Configures the protocol scheme used for requests.", - "$ref": "#/definitions/scheme" - }, - "basic_auth": { - "$ref": "#/definitions/basic_auth" - }, - "bearer_token": { - "$ref": "#/definitions/bearer_token" - }, - "bearer_token_file": { - "$ref": "#/definitions/bearer_token_file" - }, - "tls_config": { - "description": "Configures the scrape request's TLS settings.", - "$ref": "#/definitions/tls_config" - }, - "proxy_url": { - "description": "Optional proxy URL.", - "type": [ - "string", - "null" - ], - "format": "uri-reference" - }, - "azure_sd_configs": { - "$ref": "#/definitions/azure_sd_configs" - }, - "consul_sd_configs": { - "$ref": "#/definitions/consul_sd_configs" - }, - "dns_sd_configs": { - "$ref": "#/definitions/dns_sd_configs" - }, - "ec2_sd_configs": { - "$ref": "#/definitions/ec2_sd_configs" - }, - "file_sd_configs": { - "$ref": "#/definitions/file_sd_configs" - }, - "gce_sd_configs": { - "$ref": "#/definitions/gce_sd_configs" - }, - "kubernetes_sd_configs": { - "$ref": "#/definitions/kubernetes_sd_configs" - }, - "marathon_sd_configs": { - "$ref": "#/definitions/marathon_sd_configs" - }, - "nerve_sd_configs": { - "$ref": "#/definitions/nerve_sd_configs" - }, - "serverset_sd_configs": { - "$ref": "#/definitions/serverset_sd_configs" - }, - "triton_sd_configs": { - "$ref": "#/definitions/triton_sd_configs" - }, - "static_configs": { - "$ref": "#/definitions/static_configs" - }, - "relabel_configs": { - "description": "List of target relabel configurations.", - "$ref": "#/definitions/relabel_configs" - } - }, - "allOf": [ - { - "$ref": "#/definitions/auth" - } - ] - } - } - } - } - }, - "additionalProperties": false, - "definitions": { - "duration": { - "type": [ - "string", - "null" - ], - "pattern": "^[0-9]+(ms|[smhdwy])$" - }, - "label_name": { - "type": "string", - "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - }, - "label_value": { - "type": "string" - }, - "labels": { - "type": [ - "object", - "null" - ], - "patternProperties": { - "^[a-zA-Z_][a-zA-Z0-9_]*$": { - "$ref": "#/definitions/label_value" - } - }, - "additionalProperties": false - }, - "filepath_glob": { - "type": "string" - }, - "filepath": { - "type": [ - "string", - "null" - ], - "format": "uri-reference" - }, - "basic_auth": { - "description": "Sets the `Authorization` header on every remote write request with the configured username and password. password and password_file are mutually exclusive.", - "type": [ - "object", - "null" - ], - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": [ - "string", - "null" - ] - }, - "password_file": { - "$ref": "#/definitions/filepath" - } - }, - "oneOf": [ - { - "required": [ - "password" - ] - }, - { - "required": [ - "password_file" - ] - } - ], - "additionalProperties": false, - "required": [ - "username" - ] - }, - "bearer_token": { - "description": "Sets the `Authorization` header on every scrape request with the configured bearer token. It is mutually exclusive with `bearer_token_file`.", - "type": [ - "string", - "null" - ] - }, - "bearer_token_file": { - "description": "Sets the `Authorization` header on every scrape request with the bearer token read from the configured file. It is mutually exclusive with `bearer_token`.", - "$ref": "#/definitions/filepath" - }, - "auth": { - "allOf": [ - { - "if": { - "not": { - "properties": { - "basic_auth": { - "const": null - } - } - } - }, - "then": { - "properties": { - "bearer_token": { - "const": null - }, - "bearer_token_file": { - "const": null - } - } - } - }, - { - "if": { - "not": { - "properties": { - "bearer_token": { - "const": null - } - } - } - }, - "then": { - "properties": { - "basic_auth": { - "const": null - }, - "bearer_token_file": { - "const": null - } - } - } - }, - { - "if": { - "not": { - "properties": { - "bearer_token_file": { - "const": null - } - } - } - }, - "then": { - "properties": { - "basic_auth": { - "const": null - }, - "bearer_token": { - "const": null - } - } - } - } - ] - }, - "relabel_configs": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "source_labels": { - "description": "The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.", - "type": "array", - "items": { - "$ref": "#/definitions/label_name" - } - }, - "separator": { - "description": "Separator placed between concatenated source label values.", - "type": "string", - "default": ";" - }, - "target_label": { - "description": "Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.", - "$comment": "https://github.com/prometheus/prometheus/blob/release-2.13/config/testdata/conf.good.yml#L146 has a regex capture group, violating vanilla label_name definition.", - "type": "string" - }, - "regex": { - "description": "Regular expression against which the extracted value is matched.", - "$comment": "https://github.com/prometheus/prometheus/blob/release-2.13/config/testdata/conf.good.yml#L111 has integer instead of string", - "default": "(.*)" - }, - "modulus": { - "description": "Modulus to take of the hash of the source label values.", - "type": "integer" - }, - "replacement": { - "description": "Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.", - "type": "string", - "default": "$1" - }, - "action": { - "description": "Action to perform based on regex matching.", - "type": "string", - "enum": [ - "replace", - "keep", - "drop", - "hashmod", - "labelmap", - "labeldrop", - "labelkeep" - ], - "default": "replace" - } - }, - "if": { - "properties": { - "action": { - "const": "replace" - } - } - }, - "then": { - "required": [ - "target_label" - ] - } - } - }, - "tls_config": { - "type": [ - "object", - "null" - ], - "properties": { - "ca_file": { - "description": "CA certificate to validate API server certificate with.", - "$ref": "#/definitions/filepath" - }, - "cert_file": { - "description": "Certificate file for client cert authentication to the server.", - "$ref": "#/definitions/filepath" - }, - "key_file": { - "description": "Key file for client cert authentication to the server.", - "$ref": "#/definitions/filepath" - }, - "server_name": { - "description": "ServerName extension to indicate the name of the server.", - "type": [ - "string", - "null" - ] - }, - "insecure_skip_verify": { - "description": "Disable validation of the server certificate.", - "type": [ - "boolean", - "null" - ] - } - }, - "additionalProperties": false - }, - "scheme": { - "type": [ - "string", - "null" - ], - "enum": [ - "http", - "https", - null - ] - }, - "azure_sd_configs": { - "description": "List of Azure service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the Azure API.", - "type": "object" - } - }, - "consul_sd_configs": { - "description": "List of Consul service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the Consul API. It is to be defined as the Consul documentation requires.", - "type": "object" - } - }, - "dns_sd_configs": { - "description": "List of DNS service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "A DNS-based service discovery configuration allows specifying a set of DNS domain names which are periodically queried to discover a list of targets. The DNS servers to be contacted are read from /etc/resolv.conf. This service discovery method only supports basic DNS A, AAAA and SRV record queries, but not the advanced DNS-SD approach specified in RFC6763. During the relabeling phase, the meta label __meta_dns_name is available on each target and is set to the record name that produced the discovered target.", - "type": "object" - } - }, - "ec2_sd_configs": { - "description": "List of EC2 service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the EC2 API.", - "type": "object" - } - }, - "openstack_sd_configs": { - "description": "List of OpenStack service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the OpenStack API.", - "type": "object" - } - }, - "file_sd_configs": { - "description": "List of file service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "files": { - "description": "Patterns for files from which target groups are extracted. Where the pattern may be a path ending in .json, .yml or .yaml. The last path segment may contain a single * that matches any character sequence, e.g. my/path/tg_*.json.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "refresh_interval": { - "description": "Refresh interval to re-read the files.", - "$ref": "#/definitions/duration", - "default": "5m" - } - } - } - }, - "gce_sd_configs": { - "description": "List of GCE service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the GCE API.", - "type": "object" - } - }, - "kubernetes_sd_configs": { - "description": "List of Kubernetes service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the Kubernetes API.", - "type": "object" - } - }, - "marathon_sd_configs": { - "description": "List of Marathon service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object" - } - }, - "nerve_sd_configs": { - "description": "List of AirBnB's Nerve service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object" - } - }, - "serverset_sd_configs": { - "description": "List of Zookeeper Serverset service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object" - } - }, - "triton_sd_configs": { - "description": "List of Triton service discovery configurations.", - "type": [ - "array", - "null" - ], - "items": { - "description": "The information to access the Triton discovery API.", - "type": "object" - } - }, - "static_configs": { - "description": "List of labeled statically configured targets for this job.", - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "targets": { - "description": "The targets specified by the static config.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "labels": { - "description": "Labels assigned to all metrics scraped from the targets.", - "$ref": "#/definitions/labels" - } - } - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/JsonSchemaDraft-7/prometheus-rules.json b/test/blackbox/docs/JsonSchemaDraft-7/prometheus-rules.json deleted file mode 100644 index cca6053410..0000000000 --- a/test/blackbox/docs/JsonSchemaDraft-7/prometheus-rules.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://json.schemastore.org/prometheus.rules", - "title": "Prometheus Rules", - "description": "Prometheus rules file", - "type": [ - "object", - "null" - ], - "properties": { - "groups": { - "type": [ - "array", - "null" - ], - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the group. Must be unique within a file.", - "type": "string" - }, - "interval": { - "description": "How often rules in the group are evaluated.", - "$ref": "#/definitions/duration" - }, - "rules": { - "type": [ - "array", - "null" - ], - "items": { - "oneOf": [ - { - "$ref": "#/definitions/recording_rule" - }, - { - "$ref": "#/definitions/alerting_rule" - } - ] - } - } - }, - "required": [ - "name" - ], - "additionalProperties": false - } - } - }, - "additionalProperties": false, - "definitions": { - "duration": { - "type": [ - "string", - "null" - ], - "pattern": "^[0-9]+(ms|[smhdwy])$" - }, - "label_name": { - "type": "string", - "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" - }, - "label_value": { - "type": "string" - }, - "labels": { - "type": [ - "object", - "null" - ], - "patternProperties": { - "^[a-zA-Z_][a-zA-Z0-9_]*$": { - "$ref": "#/definitions/label_value" - } - }, - "additionalProperties": false - }, - "tmpl_string": { - "description": "A string which is template-expanded before usage.", - "type": "string" - }, - "annotations": { - "type": [ - "object", - "null" - ], - "patternProperties": { - "^[a-zA-Z_][a-zA-Z0-9_]*$": { - "$ref": "#/definitions/tmpl_string" - } - }, - "additionalProperties": false - }, - "recording_rule": { - "type": "object", - "properties": { - "record": { - "description": "The name of the time series to output to. Must be a valid metric name.", - "type": "string" - }, - "expr": { - "description": "The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and the result recorded as a new set of time series with the metric name as given by 'record'.", - "type": "string" - }, - "labels": { - "description": "Labels to add or overwrite before storing the result.", - "$ref": "#/definitions/labels" - } - }, - "required": [ - "record", - "expr" - ], - "additionalProperties": false - }, - "alerting_rule": { - "type": "object", - "properties": { - "alert": { - "description": "The name of the alert. Must be a valid metric name.", - "type": "string" - }, - "expr": { - "description": "The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.", - "type": "string" - }, - "for": { - "description": "Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending.", - "$ref": "#/definitions/duration" - }, - "labels": { - "description": "Labels to add or overwrite for each alert.", - "$ref": "#/definitions/labels" - }, - "annotations": { - "description": "Annotations to add to each alert.", - "$ref": "#/definitions/annotations" - } - }, - "required": [ - "alert", - "expr" - ], - "additionalProperties": false - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/OpenAPI-3_0/petstore.json b/test/blackbox/docs/OpenAPI-3_0/petstore.json deleted file mode 100644 index 4ffa82a0cf..0000000000 --- a/test/blackbox/docs/OpenAPI-3_0/petstore.json +++ /dev/null @@ -1,1225 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Swagger Petstore - OpenAPI 3.0", - "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)", - "termsOfService": "http://swagger.io/terms/", - "contact": { - "email": "apiteam@swagger.io" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.0.6" - }, - "externalDocs": { - "description": "Find out more about Swagger", - "url": "http://swagger.io" - }, - "servers": [ - { - "url": "/api/v3" - } - ], - "tags": [ - { - "name": "pet", - "description": "Everything about your Pets", - "externalDocs": { - "description": "Find out more", - "url": "http://swagger.io" - } - }, - { - "name": "store", - "description": "Operations about user" - }, - { - "name": "user", - "description": "Access to Petstore orders", - "externalDocs": { - "description": "Find out more about our store", - "url": "http://swagger.io" - } - } - ], - "paths": { - "/pet": { - "put": { - "tags": [ - "pet" - ], - "summary": "Update an existing pet", - "description": "Update an existing pet by Id", - "operationId": "updatePet", - "requestBody": { - "description": "Update an existent pet in the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "405": { - "description": "Validation exception" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "post": { - "tags": [ - "pet" - ], - "summary": "Add a new pet to the store", - "description": "Add a new pet to the store", - "operationId": "addPet", - "requestBody": { - "description": "Create a new pet in the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByStatus": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by status", - "description": "Multiple status values can be provided with comma separated strings", - "operationId": "findPetsByStatus", - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": false, - "explode": true, - "schema": { - "type": "string", - "default": "available", - "enum": [ - "available", - "pending", - "sold" - ] - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - } - } - }, - "400": { - "description": "Invalid status value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByTags": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by tags", - "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", - "operationId": "findPetsByTags", - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": false, - "explode": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - } - } - }, - "400": { - "description": "Invalid tag value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/{petId}": { - "get": { - "tags": [ - "pet" - ], - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "api_key": [] - }, - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "post": { - "tags": [ - "pet" - ], - "summary": "Updates a pet in the store with form data", - "description": "", - "operationId": "updatePetWithForm", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet that needs to be updated", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "name", - "in": "query", - "description": "Name of pet that needs to be updated", - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "Status of pet that needs to be updated", - "schema": { - "type": "string" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "delete": { - "tags": [ - "pet" - ], - "summary": "Deletes a pet", - "description": "", - "operationId": "deletePet", - "parameters": [ - { - "name": "api_key", - "in": "header", - "description": "", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "400": { - "description": "Invalid pet value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/{petId}/uploadImage": { - "post": { - "tags": [ - "pet" - ], - "summary": "uploads an image", - "description": "", - "operationId": "uploadFile", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "additionalMetadata", - "in": "query", - "description": "Additional Metadata", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponse" - } - } - } - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/store/inventory": { - "get": { - "tags": [ - "store" - ], - "summary": "Returns pet inventories by status", - "description": "Returns a map of status codes to quantities", - "operationId": "getInventory", - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, - "/store/order": { - "post": { - "tags": [ - "store" - ], - "summary": "Place an order for a pet", - "description": "Place a new order in the store", - "operationId": "placeOrder", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Order" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "405": { - "description": "Invalid input" - } - } - } - }, - "/store/order/{orderId}": { - "get": { - "tags": [ - "store" - ], - "summary": "Find purchase order by ID", - "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", - "operationId": "getOrderById", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of order that needs to be fetched", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Order" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - }, - "delete": { - "tags": [ - "store" - ], - "summary": "Delete purchase order by ID", - "description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", - "operationId": "deleteOrder", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - } - }, - "/user": { - "post": { - "tags": [ - "user" - ], - "summary": "Create user", - "description": "This can only be done by the logged in user.", - "operationId": "createUser", - "requestBody": { - "description": "Created user object", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "responses": { - "default": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - } - } - } - }, - "/user/createWithList": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "Creates list of users with given input array", - "operationId": "createUsersWithListInput", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "default": { - "description": "successful operation" - } - } - } - }, - "/user/login": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs user into the system", - "description": "", - "operationId": "loginUser", - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "headers": { - "X-Rate-Limit": { - "description": "calls per hour allowed by the user", - "schema": { - "type": "integer", - "format": "int32" - } - }, - "X-Expires-After": { - "description": "date in UTC when token expires", - "schema": { - "type": "string", - "format": "date-time" - } - } - }, - "content": { - "application/xml": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs out current logged in user session", - "description": "", - "operationId": "logoutUser", - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "get": { - "tags": [ - "user" - ], - "summary": "Get user by user name", - "description": "", - "operationId": "getUserByName", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be fetched. Use user1 for testing. ", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "put": { - "tags": [ - "user" - ], - "summary": "Update user", - "description": "This can only be done by the logged in user.", - "operationId": "updateUser", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "name that need to be deleted", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Update an existent user in the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "responses": { - "default": { - "description": "successful operation" - } - } - }, - "delete": { - "tags": [ - "user" - ], - "summary": "Delete user", - "description": "This can only be done by the logged in user.", - "operationId": "deleteUser", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - } - } - }, - "components": { - "schemas": { - "Order": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 10 - }, - "petId": { - "type": "integer", - "format": "int64", - "example": 198772 - }, - "quantity": { - "type": "integer", - "format": "int32", - "example": 7 - }, - "shipDate": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Order Status", - "example": "approved", - "enum": [ - "placed", - "approved", - "delivered" - ] - }, - "complete": { - "type": "boolean" - } - }, - "xml": { - "name": "order" - } - }, - "Customer": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 100000 - }, - "username": { - "type": "string", - "example": "fehguy" - }, - "address": { - "type": "array", - "xml": { - "name": "addresses", - "wrapped": true - }, - "items": { - "$ref": "#/components/schemas/Address" - } - } - }, - "xml": { - "name": "customer" - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string", - "example": "437 Lytton" - }, - "city": { - "type": "string", - "example": "Palo Alto" - }, - "state": { - "type": "string", - "example": "CA" - }, - "zip": { - "type": "string", - "example": "94301" - } - }, - "xml": { - "name": "address" - } - }, - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "type": "string", - "example": "Dogs" - } - }, - "xml": { - "name": "category" - } - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 10 - }, - "username": { - "type": "string", - "example": "theUser" - }, - "firstName": { - "type": "string", - "example": "John" - }, - "lastName": { - "type": "string", - "example": "James" - }, - "email": { - "type": "string", - "example": "john@email.com" - }, - "password": { - "type": "string", - "example": "12345" - }, - "phone": { - "type": "string", - "example": "12345" - }, - "userStatus": { - "type": "integer", - "description": "User Status", - "format": "int32", - "example": 1 - } - }, - "xml": { - "name": "user" - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "tag" - } - }, - "Pet": { - "required": [ - "name", - "photoUrls" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 10 - }, - "name": { - "type": "string", - "example": "doggie" - }, - "category": { - "$ref": "#/components/schemas/Category" - }, - "photoUrls": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "type": "string", - "xml": { - "name": "photoUrl" - } - } - }, - "tags": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": [ - "available", - "pending", - "sold" - ] - } - }, - "xml": { - "name": "pet" - } - }, - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - }, - "xml": { - "name": "##default" - } - } - }, - "requestBodies": { - "Pet": { - "description": "Pet object that needs to be added to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "UserArray": { - "description": "List of user object", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - } - } - } - } - }, - "securitySchemes": { - "petstore_auth": { - "type": "oauth2", - "flows": { - "implicit": { - "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", - "scopes": { - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - } - } - } - }, - "api_key": { - "type": "apiKey", - "name": "api_key", - "in": "header" - } - } - } -} \ No newline at end of file diff --git a/test/blackbox/docs/OpenAPI-3_0/postman-api.json b/test/blackbox/docs/OpenAPI-3_0/postman-api.json deleted file mode 100644 index 9fb86f97d7..0000000000 --- a/test/blackbox/docs/OpenAPI-3_0/postman-api.json +++ /dev/null @@ -1,6874 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Postman API", - "description": "The Postman API allows you to programmatically access data stored in Postman account with ease.\n\nThe easiest way to get started with the API is to click the **fork** button to fork this collection to your own workspace and use Postman to send requests.\n\n\n# Overview\n\n1. You need a valid API Key to send requests to the API endpoints. You can get your key from the [integrations dashboard](https://go.postman.co/settings/me/api-keys).\n\n1. The API has an access rate limit applied to it.\n\n1. The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a `301` redirect to corresponding HTTPS resources.\n\n1. Response to every request is sent in [JSON format](https://en.wikipedia.org/wiki/JSON). In case the API request results in an error, it is represented by an `\"error\": {}` key in the JSON response.\n\n1. The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman, and `POST` implies you want to save something new to Postman.\n\n1. The API calls will respond with appropriate [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A `200 OK` indicates all went well, while `4XX` or `5XX` response codes indicate an error from the requesting client or our API servers respectively.\n\n1. Individual resources in your Postman Account is accessible using its unique id (`uid`). The `uid` is a simple concatenation of the resource owner's user-id and the resource-id. For example, a collection's `uid` is `{{owner_id}}-{{collection_id}}`.\n\n# Authentication\n\nAn API Key is required to be sent as part of every request to the Postman API, in the form of an `X-Api-Key` request header.\n\n> If you do not have an API Key, you can easily generate one by heading over to the [Postman Integrations Dashboard](https://go.postman.co/integrations/services/pm_pro_api).\n\nAn API Key tells our API server that the request it received came from you. Everything that you have access to in Postman is accessible with an API Key that is generated by you.\n\nFor ease of use inside Postman, you could store your API key in an [environment variable](https://www.getpostman.com/docs/environments) called `postman_api_key` and this [Collection](https://www.getpostman.com/docs/collections) will automatically use it to make API calls.\n\n## API Key related error response\n\nIf an API Key is missing, malformed, or invalid, you will receive a `401 Unauthorised` response code and the following JSON response:\n\n```\n{\n \"error\": { \n \"name\": \"AuthenticationError\",\n \"message\": \"API Key missing. Every request requires an API Key to be sent.\"\n }\n}\n```\n\n## Using the API Key as a query parameter\n\nEvery request that accepts API Key as `X-Api-Key` request header, also accepts the key when sent as `apikey` URL query parameter.\n\nAPI key sent as part of the header has a higher priority in case you send the key using both request header and query parameter.\n\n\n# Rate Limits\n\nAPI access rate limits are applied at a per-key basis in unit time. Access to the API using a key is limited to **60 requests per minute**. In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.\n\n\n| Header | Description |\n|-------------------------|-------------|\n| `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. |\n\n\nOnce you hit the rate limit, you will receive a response similar to the following JSON, with a status code of `429 Too Many Requests`.\n\n```json\n{\n \"error\": {\n \"name\": \"rateLimitError\",\n \"message\": \"Rate Limit exceeded. Please retry at 1465452702843\"\n }\n}\n```\n\n\n# Support\n\nFor help regarding accessing the Postman API, feel free to discuss it in our [Discourse Community](https://community.getpostman.com). You can also drop in a line at [help@getpostman.com](mailto:help@getpostman.com).\n\nIn the event you receive a `503` response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes. If the outage persists, or your receive any other form of `5XX` error, kindly let us know.\n\n\n# Terms of Use\n\nFor information on API terms of use and privacy, refer to our terms at [http://postman.com/legal/terms/](http://postman.com/legal/terms/) and our privacy policy at [https://www.postman.com/legal/privacy-policy/](https://www.postman.com/legal/privacy-policy/).\n\n\n# API Reference", - "version": "1.20.0", - "contact": {} - }, - "servers": [ - { - "url": "https://api.getpostman.com" - } - ], - "paths": { - "/apis": { - "get": { - "tags": [ - "API" - ], - "summary": "Get all APIs", - "description": "This call fetches all the APIs present in the specified workspace\n\nResponse contains an array named `apis` which would contain all the details of APIs present in the workspace.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getAllApIs", - "parameters": [ - { - "name": "workspace", - "in": "query", - "schema": { - "type": "string", - "example": "{{workspaceId}}" - }, - "description": "Only return APIs that are inside the given workspace." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "example": "{{since}}" - }, - "description": "Only return APIs that have been updated after this time. Time is represented using the ISO 8601 date and time format." - }, - { - "name": "until", - "in": "query", - "schema": { - "type": "string", - "example": "{{until}}" - }, - "description": "Only return APIs that have been updated before this time. Time is represented using the ISO 8601 date and time format." - }, - { - "name": "createdBy", - "in": "query", - "schema": { - "type": "string", - "example": "{{createdBy}}" - }, - "description": "Only return APIs that have been created by the user ID represented by the given value." - }, - { - "name": "updatedBy", - "in": "query", - "schema": { - "type": "string", - "example": "{{updatedBy}}" - }, - "description": "Only return APIs that have been updated by the user ID represented by the given value." - }, - { - "name": "isPublic", - "in": "query", - "schema": { - "type": "string", - "example": "{{isPublic}}" - }, - "description": "Only return APIs with the corresponding privacy state. Public APIs have the isPublic value true; private APIs have the isPublic value false." - }, - { - "name": "name", - "in": "query", - "schema": { - "type": "string", - "example": "{{name}}" - }, - "description": "Only return APIs whose name includes the given value. Matching is case insensitive." - }, - { - "name": "summary", - "in": "query", - "schema": { - "type": "string", - "example": "{{summary}}" - }, - "description": "Only return APIs whose summary includes the given value. Matching is case insensitive." - }, - { - "name": "description", - "in": "query", - "schema": { - "type": "string", - "example": "{{description}}" - }, - "description": "Only return APIs whose description includes the given value. Matching is case insensitive." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "example": "{{sort}}" - }, - "description": "The value of sort can be one of the names of the fields included in the response." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "example": "{{direction}}" - }, - "description": "The sorting direction, which can be ascending or descending. The value can be asc to specify an ascending direction or desc to specify a descending direction. If none is specified, the default sorting direction is descending for timestamp and numeric fields and ascending otherwise. An ID is not considered a numeric field." - } - ], - "responses": { - "200": { - "description": "" - } - } - }, - "post": { - "tags": [ - "API" - ], - "summary": "Create API", - "description": "This call creates a new API with a default API Version. \n\nRequest body should contain an `api` object which should atleast have a property `name`.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description`, etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createApi", - "parameters": [ - { - "name": "workspace", - "in": "query", - "schema": { - "type": "string", - "example": "{{workspaceId}}" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is description." - }, - "name": { - "type": "string", - "example": "Sync Service API" - }, - "summary": { - "type": "string", - "example": "This is supposed to be a short summary." - } - } - } - } - }, - "example": { - "api": { - "description": "This is description.", - "name": "Sync Service API", - "summary": "This is supposed to be a short summary." - } - } - } - } - }, - "responses": { - "200": { - "description": "Create API", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "description": { - "type": "string", - "example": "This is supposed to handle markdown *descriptions*." - }, - "id": { - "type": "string", - "example": "387c2863-6ee3-4a56-8210-225f774edade" - }, - "name": { - "type": "string", - "example": "Sync API" - }, - "summary": { - "type": "string", - "example": "This is a summary" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Create API": { - "value": { - "api": { - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "description": "This is supposed to handle markdown *descriptions*.", - "id": "387c2863-6ee3-4a56-8210-225f774edade", - "name": "Sync API", - "summary": "This is a summary", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - } - }, - "/apis/{apiId}": { - "get": { - "tags": [ - "API" - ], - "summary": "Single API", - "description": "This call fetches a single API having the specified id.\n\nResponse contains an `api` object with all the details related to the queried API, namely, `id`, `name`, `summary`, `description` etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleApi", - "responses": { - "200": { - "description": "Get single API", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "description": { - "type": "string", - "example": "This is a description.This is a description." - }, - "id": { - "type": "string", - "example": "387c2863-6ee3-4a56-8210-225f774edade" - }, - "name": { - "type": "string", - "example": "Sync API" - }, - "summary": { - "type": "string", - "example": "This is a summary" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Get single API": { - "value": { - "api": { - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "description": "This is a description.This is a description.", - "id": "387c2863-6ee3-4a56-8210-225f774edade", - "name": "Sync API", - "summary": "This is a summary", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "API" - ], - "summary": "Update an API", - "description": "This call updates an existing API . \n\nRequest body should contain an `api` object which should have the fields to be updated. Only `name`, `summary` and `description` fields can be edited for an API.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description` etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateAnApi", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is an updated Description" - }, - "name": { - "type": "string", - "example": "New name" - } - } - } - } - }, - "example": { - "api": { - "description": "This is an updated Description", - "name": "New name" - } - } - } - } - }, - "responses": { - "200": { - "description": "Update an API", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "description": { - "type": "string", - "example": "This is a description." - }, - "id": { - "type": "string", - "example": "387c2863-6ee3-4a56-8210-225f774edade" - }, - "name": { - "type": "string", - "example": "Sync API" - }, - "summary": { - "type": "string", - "example": "This is a summary" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Update an API": { - "value": { - "api": { - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "description": "This is a description.", - "id": "387c2863-6ee3-4a56-8210-225f774edade", - "name": "Sync API", - "summary": "This is a summary", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "API" - ], - "summary": "Delete an API", - "description": "This call deletes an existing API having the specified id. \n\nResponse contains an `api` object with `id` of the API which was deleted.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteAnApi", - "responses": { - "200": { - "description": "Delete an API", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "api": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "387c2863-6ee3-4a56-8210-225f774edade" - } - } - } - } - }, - "examples": { - "Delete an API": { - "value": { - "api": { - "id": "387c2863-6ee3-4a56-8210-225f774edade" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions": { - "get": { - "tags": [ - "API", - "API Version" - ], - "summary": "Get All API Versions", - "description": "This call fetches details about the all the API Versions in the specified API.\n\nThe response will contain an array `versions` object which would be a list of all the API Version along with their details.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getAllApiVersions", - "responses": { - "200": { - "description": "Get All API versions", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "versions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "description": { - "type": "string", - "example": "Description" - }, - "id": { - "type": "string", - "example": "024660a6-c837-46ca-91d8-7e8dd7c669de" - }, - "name": { - "type": "string", - "example": "0.1" - }, - "summary": { - "type": "string", - "example": "Summary" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - } - }, - "examples": { - "Get All API versions": { - "value": { - "versions": [ - { - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "description": "Description", - "id": "024660a6-c837-46ca-91d8-7e8dd7c669de", - "name": "0.1", - "summary": "Summary", - "updatedAt": "2019-02-12 19:34:49" - }, - { - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "description": "Description", - "id": "00932d3b-20f1-454f-a77e-38b4023163ea", - "name": "0.2", - "summary": "Summary", - "updatedAt": "2019-02-12 19:34:49" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "API", - "API Version" - ], - "summary": "Create API Version", - "description": "This call creates a new API version in the specified API. \n\nRequest body should contain a `version` object which should have fields:\n\n\n\n\t\n\t\n\n\n\t\n\t\n\n
nameRequired. Name of the API Version
source\n\t\tIf specified, it will copy the contents of the specified api version to create a new api verison.\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t
idRequired. Id of the apiversion from where the details are to be copied
schemaBoolean. If true then copies the schema from the specified api version
relationsObject. {\"<relationType>\": true/false}. \n\t\t\t\t\tAllowed relation types are `mock`, `monitor`, `documentation`, `contracttest`, `integrationtest`, `testsuite`, `environment`\n\t\t\t\tRelation types which should be copied over to the new api verison
\n\t
\n\nResponse contains a `version` object with all the details related to the created API Version, namely, `id`, `name`, `api`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createApiVersion", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "1.0" - }, - "source": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "{{apiVersionId}}" - }, - "relations": { - "type": "object", - "properties": { - "documentation": { - "type": "boolean", - "example": true - }, - "mock": { - "type": "boolean", - "example": true - }, - "monitor": { - "type": "boolean", - "example": true - } - } - }, - "schema": { - "type": "boolean", - "example": true - } - } - } - } - } - } - }, - "example": { - "version": { - "name": "1.0", - "source": { - "id": "{{apiVersionId}}", - "relations": { - "documentation": true, - "mock": true, - "monitor": true - }, - "schema": true - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Create API version", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "api": { - "type": "string", - "example": "2b95d07c-8379-4bd1-924f-e7e1af185284" - }, - "id": { - "type": "string", - "example": "d71cf403-c549-4c7c-9dc6-a6a105acf67c" - }, - "name": { - "type": "string", - "example": "1.0" - } - } - } - } - }, - "examples": { - "Create API version": { - "value": { - "version": { - "api": "2b95d07c-8379-4bd1-924f-e7e1af185284", - "id": "d71cf403-c549-4c7c-9dc6-a6a105acf67c", - "name": "1.0" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}": { - "get": { - "tags": [ - "API", - "API Version" - ], - "summary": "Get an API Version", - "description": "This call fetches details about the specified API Version.\n\nThe response will contain a `version` object which would contain all the details of the API Version.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getAnApiVersion", - "responses": { - "200": { - "description": "Get an API version", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "api": { - "type": "string", - "example": "06e41ca3-8bea-4bc5-a726-70338b9f1940" - }, - "createdAt": { - "type": "string", - "example": "2019-07-21T16:31:15.000Z" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "id": { - "type": "string", - "example": "03c17f53-7e2e-427d-b55a-006b244f29ff" - }, - "name": { - "type": "string", - "example": "0.1" - }, - "schema": { - "type": "array", - "items": { - "type": "string", - "example": "3484cd1e-e00d-4c39-aea4-539663afe898" - } - }, - "updatedAt": { - "type": "string", - "example": "2019-07-21T16:31:15.000Z" - }, - "updatedBy": { - "type": "string", - "example": "5665" - } - } - } - } - }, - "examples": { - "Get an API version": { - "value": { - "version": { - "api": "06e41ca3-8bea-4bc5-a726-70338b9f1940", - "createdAt": "2019-07-21T16:31:15.000Z", - "createdBy": "5665", - "id": "03c17f53-7e2e-427d-b55a-006b244f29ff", - "name": "0.1", - "schema": [ - "3484cd1e-e00d-4c39-aea4-539663afe898" - ], - "updatedAt": "2019-07-21T16:31:15.000Z", - "updatedBy": "5665" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "API", - "API Version" - ], - "summary": "Update an API Version", - "description": "This call updates an existing API Version. \n\nRequest body should contain a `version` object with the fields which need to be updated. Only field which can be updated is `name`.\n\nResponse contains a `version` object with all the details related to the created API Version, namely, `id`, `name`, `api` etc.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateAnApiVersion", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "2.0" - } - } - } - } - }, - "example": { - "version": { - "name": "2.0" - } - } - } - } - }, - "responses": { - "200": { - "description": "Update an API version", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "api": { - "type": "string", - "example": "2b95d07c-8379-4bd1-924f-e7e1af185284" - }, - "createdAt": { - "type": "string", - "example": "2019-07-26T11:24:15.000Z" - }, - "createdBy": { - "type": "string", - "example": "12" - }, - "id": { - "type": "string", - "example": "d71cf403-c549-4c7c-9dc6-a6a105acf67c" - }, - "name": { - "type": "string", - "example": "2.0" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-09T09:27:36.000Z" - }, - "updatedBy": { - "type": "string", - "example": "5665" - } - } - } - } - }, - "examples": { - "Update an API version": { - "value": { - "version": { - "api": "2b95d07c-8379-4bd1-924f-e7e1af185284", - "createdAt": "2019-07-26T11:24:15.000Z", - "createdBy": "12", - "id": "d71cf403-c549-4c7c-9dc6-a6a105acf67c", - "name": "2.0", - "updatedAt": "2019-08-09T09:27:36.000Z", - "updatedBy": "5665" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "API", - "API Version" - ], - "summary": "Delete an API Version", - "description": "This call deletes an existing API Version having the specified id. \n\nResponse contains an `version` object with `id` of the API Version which was deleted.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteAnApiVersion", - "responses": { - "200": { - "description": "Delete an API version", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "03c17f53-7e2e-427d-b55a-006b244f29ff" - } - } - } - } - }, - "examples": { - "Delete an API version": { - "value": { - "version": { - "id": "03c17f53-7e2e-427d-b55a-006b244f29ff" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/contracttest": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get contract test relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getContractTestRelations", - "responses": { - "200": { - "description": "Get contract test relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contracttest": { - "type": "array", - "items": { - "type": "object", - "properties": { - "collectionId": { - "type": "string", - "example": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745" - }, - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get contract test relations": { - "value": { - "contracttest": [ - { - "collectionId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745", - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "collectionId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725", - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/documentation": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get documentation relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getDocumentationRelations", - "responses": { - "200": { - "description": "Get documentation relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "documentation": { - "type": "array", - "items": { - "type": "object", - "properties": { - "collectionId": { - "type": "string", - "example": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745" - }, - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get documentation relations": { - "value": { - "documentation": [ - { - "collectionId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745", - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "collectionId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725", - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/environment": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get environment relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getEnvironmentRelations", - "responses": { - "200": { - "description": "Get environment relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get environment relations": { - "value": { - "environment": [ - { - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/integrationtest": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get integration test relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getIntegrationTestRelations", - "responses": { - "200": { - "description": "Get integration test relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "integrationtest": { - "type": "array", - "items": { - "type": "object", - "properties": { - "collectionId": { - "type": "string", - "example": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745" - }, - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get integration test relations": { - "value": { - "integrationtest": [ - { - "collectionId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745", - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "collectionId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725", - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/monitor": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get monitor relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getMonitorRelations", - "responses": { - "200": { - "description": "Get monitor relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "monitorId": { - "type": "string", - "example": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get monitor relations": { - "value": { - "monitor": [ - { - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "monitorId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "monitorId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/relations": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get linked relations", - "description": "This call fetches all the relations which are linked to the specified API version along with their details.\n\nThe response will contain a `relations` object which lists all the relation types which are linked to the API version. Each of the relation type will be an object which details the relations of this type. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getLinkedRelations", - "responses": { - "200": { - "description": "Get linked relations for an API version", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "relations": { - "type": "object", - "properties": { - "contracttest": { - "type": "object", - "properties": { - "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - }, - "integrationtest": { - "type": "object", - "properties": { - "521b0486-ab91-4d3a-9189-43c9380a0533": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "521b0486-ab91-4d3a-9189-43c9380a0533" - }, - "name": { - "type": "string", - "example": "C1" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T11:40:39.000Z" - } - } - }, - "a236b715-e682-460b-97b6-c1db24f7612e": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "a236b715-e682-460b-97b6-c1db24f7612e" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - }, - "mock": { - "type": "object", - "properties": { - "4ccd755f-2c80-481b-a262-49b55e12f5e1": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "4ccd755f-2c80-481b-a262-49b55e12f5e1" - }, - "name": { - "type": "string", - "example": "Mock" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-20T10:18:13.000Z" - }, - "url": { - "type": "string", - "example": "https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io" - } - } - } - } - } - } - } - } - }, - "examples": { - "Get linked relations for an API version": { - "value": { - "relations": { - "contracttest": { - "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2": { - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - } - }, - "integrationtest": { - "521b0486-ab91-4d3a-9189-43c9380a0533": { - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - }, - "a236b715-e682-460b-97b6-c1db24f7612e": { - "id": "a236b715-e682-460b-97b6-c1db24f7612e", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - } - }, - "mock": { - "4ccd755f-2c80-481b-a262-49b55e12f5e1": { - "id": "4ccd755f-2c80-481b-a262-49b55e12f5e1", - "name": "Mock", - "updatedAt": "2019-08-20T10:18:13.000Z", - "url": "https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io" - } - } - } - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "API", - "Relations" - ], - "summary": "Create relations", - "description": "This call allows you to add existing Postman entities as new relations to an API. The request body should contain the relations to be created along with an array of entity IDs. \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
RelationEntity ID type
contracttestCollection UIDs
integrationtestCollection UIDs
documentationCollection UIDs
testsuiteCollection UIDs
environmentEnvironment UIDs
mockMock IDs
monitorMonitor IDs
\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createRelations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contracttest": { - "type": "array", - "items": { - "type": "string", - "example": "collection-uid-1" - } - }, - "documentation": { - "type": "array", - "items": { - "type": "string", - "example": "collection-uid-3" - } - }, - "mock": { - "type": "array", - "items": { - "type": "string", - "example": "mock-uid-1" - } - }, - "testsuite": { - "type": "array", - "items": { - "type": "string", - "example": "collection-uid-1" - } - } - } - }, - "example": { - "contracttest": [ - "collection-uid-1" - ], - "documentation": [ - "collection-uid-3" - ], - "mock": [ - "mock-uid-1" - ], - "testsuite": [ - "collection-uid-1", - "collection-uid-2" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Create multiple relations from existing collections", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contracttest": { - "type": "array", - "items": { - "type": "string", - "example": "5bcece87-ca4b-4e75-a967-2a6845626164" - } - }, - "documentation": { - "type": "array", - "items": { - "type": "string", - "example": "2084eba6-a17b-4751-8f03-ea60f30ba19c" - } - }, - "testsuite": { - "type": "array", - "items": { - "type": "string", - "example": "e525fa71-035e-4620-acda-ce878524f1e7" - } - } - } - }, - "examples": { - "Create multiple relations from existing collections": { - "value": { - "contracttest": [ - "5bcece87-ca4b-4e75-a967-2a6845626164" - ], - "documentation": [ - "2084eba6-a17b-4751-8f03-ea60f30ba19c" - ], - "testsuite": [ - "e525fa71-035e-4620-acda-ce878524f1e7", - "17a974b2-ce79-4b95-9d3f-217d6ff7e979" - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/schemas": { - "post": { - "tags": [ - "API", - "Schema" - ], - "summary": "Create Schema", - "description": "This call creates a new schema.\n\nRequest body should contain a `schema` object which should atleast have these properties with `string` values:\n\n- **`type`**: Allowed types are `openapi3`, `openapi2`, `openapi1`, `raml` and `graphql`.\n- **`language`** : Allowed languages are `json` and `yaml` for OpenAPI and RAML schema types. GraphQL schema type accepts only `graphql` language.\n- **`schema`**: Optional. If passed, must be the content of the schema as a `string`.\n\nResponse contains a `schema` object with all the details related to the created schema, namely, `id`, `language`, `type` etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createSchema", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "language": { - "type": "string", - "example": "yaml" - }, - "schema": { - "type": "string", - "example": "{\n \"openapi\": \"3.0.0\",\n \"info\": null,\n \"version\": \"v1.0\",\n \"title\": \"APi\",\n \"servers\": [\n {\n \"url\": \"http://localhost:3000\"\n }\n ],\n \"paths\": {\n \"/user\": {\n \"get\": {\n \"summary\": \"Returns details about a particular user\",\n \"operationId\": \"listUser\",\n \"tags\": [\n \"user\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"query\",\n \"description\": \"ID of the user\",\n \"required\": true,\n \"schema\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Details about a user by ID\",\n \"headers\": {\n \"x-next\": {\n \"description\": \"A link to the next page of responses\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n },\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n }\n }\n }\n },\n \"default\": {\n \"description\": \"Unexpected error\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}" - }, - "type": { - "type": "string", - "example": "openapi3" - } - } - } - } - }, - "example": { - "schema": { - "language": "yaml", - "schema": "{\n \"openapi\": \"3.0.0\",\n \"info\": null,\n \"version\": \"v1.0\",\n \"title\": \"APi\",\n \"servers\": [\n {\n \"url\": \"http://localhost:3000\"\n }\n ],\n \"paths\": {\n \"/user\": {\n \"get\": {\n \"summary\": \"Returns details about a particular user\",\n \"operationId\": \"listUser\",\n \"tags\": [\n \"user\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"query\",\n \"description\": \"ID of the user\",\n \"required\": true,\n \"schema\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Details about a user by ID\",\n \"headers\": {\n \"x-next\": {\n \"description\": \"A link to the next page of responses\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n },\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n }\n }\n }\n },\n \"default\": {\n \"description\": \"Unexpected error\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}", - "type": "openapi3" - } - } - } - } - }, - "responses": { - "200": { - "description": "Create schema", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "apiVersion": { - "type": "string", - "example": "ad810c39-df60-434e-a76f-a2192cd8d81f" - }, - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "id": { - "type": "string", - "example": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822" - }, - "language": { - "type": "string", - "example": "yaml" - }, - "type": { - "type": "string", - "example": "openapi3" - }, - "updateBy": { - "type": "string", - "example": "5665" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Create schema": { - "value": { - "schema": { - "apiVersion": "ad810c39-df60-434e-a76f-a2192cd8d81f", - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "id": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822", - "language": "yaml", - "type": "openapi3", - "updateBy": "5665", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}": { - "get": { - "tags": [ - "API", - "Schema" - ], - "summary": "Get Schema", - "description": "This call fetches a single schema having the specified id.\n\nResponse contains a `schema` object with all the details related to the schema, namely, `id`, `language`, `type`, `schema` etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getSchema", - "responses": { - "200": { - "description": "Get schema", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "apiVersion": { - "type": "string", - "example": "ad810c39-df60-434e-a76f-a2192cd8d81f" - }, - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "id": { - "type": "string", - "example": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822" - }, - "language": { - "type": "string", - "example": "yaml" - }, - "type": { - "type": "string", - "example": "openapi3" - }, - "updateBy": { - "type": "string", - "example": "5665" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Get schema": { - "value": { - "schema": { - "apiVersion": "ad810c39-df60-434e-a76f-a2192cd8d81f", - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "id": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822", - "language": "yaml", - "type": "openapi3", - "updateBy": "5665", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "API", - "Schema" - ], - "summary": "Update Schema", - "description": "This call updates an existing schema.\n\nRequest body should contain a `schema` object which should atleast have these properties with `string` values:\n\n- **`type`**: Allowed types are `openapi3`, `openapi2`, `openapi1`, `raml` and `graphql`.\n- **`language`** : Allowed languages are `json` and `yaml` for OpenAPI and RAML schema types. GraphQL schema type accepts only `graphql` language.\n- **`schema`**: Optional. If passed, must be the content of the schema as a `string`.\n\nResponse contains a `schema` object with all the details related to the created schema, namely, `id`, `language`, `type` etc. \n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateSchema", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "language": { - "type": "string", - "example": "json" - }, - "schema": { - "type": "string", - "example": "{\n \"openapi\": \"3.0.0\",\n \"info\": null,\n \"version\": \"v1.0\",\n \"title\": \"APi\",\n \"servers\": [\n {\n \"url\": \"http://localhost:3000\"\n }\n ],\n \"paths\": {\n \"/user\": {\n \"get\": {\n \"summary\": \"Returns details about a particular user\",\n \"operationId\": \"listUser\",\n \"tags\": [\n \"user\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"query\",\n \"description\": \"ID of the user\",\n \"required\": true,\n \"schema\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Details about a user by ID\",\n \"headers\": {\n \"x-next\": {\n \"description\": \"A link to the next page of responses\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n },\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n }\n }\n }\n },\n \"default\": {\n \"description\": \"Unexpected error\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}" - }, - "type": { - "type": "string", - "example": "openapi3" - } - } - } - } - }, - "example": { - "schema": { - "language": "json", - "schema": "{\n \"openapi\": \"3.0.0\",\n \"info\": null,\n \"version\": \"v1.0\",\n \"title\": \"APi\",\n \"servers\": [\n {\n \"url\": \"http://localhost:3000\"\n }\n ],\n \"paths\": {\n \"/user\": {\n \"get\": {\n \"summary\": \"Returns details about a particular user\",\n \"operationId\": \"listUser\",\n \"tags\": [\n \"user\"\n ],\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"query\",\n \"description\": \"ID of the user\",\n \"required\": true,\n \"schema\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Details about a user by ID\",\n \"headers\": {\n \"x-next\": {\n \"description\": \"A link to the next page of responses\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n },\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n }\n }\n }\n },\n \"default\": {\n \"description\": \"Unexpected error\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}", - "type": "openapi3" - } - } - } - } - }, - "responses": { - "200": { - "description": "Update schema", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "apiVersion": { - "type": "string", - "example": "ad810c39-df60-434e-a76f-a2192cd8d81f" - }, - "createdAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - }, - "createdBy": { - "type": "string", - "example": "5665" - }, - "id": { - "type": "string", - "example": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822" - }, - "language": { - "type": "string", - "example": "yaml" - }, - "type": { - "type": "string", - "example": "openapi3" - }, - "updateBy": { - "type": "string", - "example": "5665" - }, - "updatedAt": { - "type": "string", - "example": "2019-02-12 19:34:49" - } - } - } - } - }, - "examples": { - "Update schema": { - "value": { - "schema": { - "apiVersion": "ad810c39-df60-434e-a76f-a2192cd8d81f", - "createdAt": "2019-02-12 19:34:49", - "createdBy": "5665", - "id": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822", - "language": "yaml", - "type": "openapi3", - "updateBy": "5665", - "updatedAt": "2019-02-12 19:34:49" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "schemaId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections": { - "post": { - "tags": [ - "API", - "Schema" - ], - "summary": "Create collection from schema", - "description": "This call creates a collection and links it to an API as one or multiple relations. \n\nRequest body requires two keys:\n- `name` - Name of the collection to be created.\n- `relations` - A list of relation(s) to be created.\n\nThe allowed relation types are `contracttest`, `integrationtest`, `testsuite`, and `documentation`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createCollectionFromSchema", - "parameters": [ - { - "name": "workspace", - "in": "query", - "schema": { - "type": "string", - "example": "{{workspaceId}}" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "My generated collection" - }, - "relations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "contracttest" - } - } - } - } - } - }, - "example": { - "name": "My generated collection", - "relations": [ - { - "type": "contracttest" - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Create collection from schema", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "e6b0d46a-8722-4f42-ab86-f5f473187ddf" - }, - "uid": { - "type": "string", - "example": "112098-e6b0d46a-8722-4f42-ab86-f5f473187ddf" - } - } - }, - "relations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "4b40f06a-5a6a-448f-bfcd-a6dbcb68da22" - }, - "type": { - "type": "string", - "example": "contracttest" - } - } - } - } - } - }, - "examples": { - "Create collection from schema": { - "value": { - "collection": { - "id": "e6b0d46a-8722-4f42-ab86-f5f473187ddf", - "uid": "112098-e6b0d46a-8722-4f42-ab86-f5f473187ddf" - }, - "relations": [ - { - "id": "4b40f06a-5a6a-448f-bfcd-a6dbcb68da22", - "type": "contracttest" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "schemaId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/testsuite": { - "get": { - "tags": [ - "API", - "Relations" - ], - "summary": "Get test suite relations", - "description": "This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "getTestSuiteRelations", - "responses": { - "200": { - "description": "Get test suite relations", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "testsuite": { - "type": "array", - "items": { - "type": "object", - "properties": { - "collectionId": { - "type": "string", - "example": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745" - }, - "id": { - "type": "string", - "example": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2" - }, - "name": { - "type": "string", - "example": "C test" - }, - "updatedAt": { - "type": "string", - "example": "2019-08-29T10:18:11.000Z" - } - } - } - } - } - }, - "examples": { - "Get test suite relations": { - "value": { - "testsuite": [ - { - "collectionId": "7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745", - "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2", - "name": "C test", - "updatedAt": "2019-08-29T10:18:11.000Z" - }, - { - "collectionId": "7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725", - "id": "521b0486-ab91-4d3a-9189-43c9380a0533", - "name": "C1", - "updatedAt": "2019-08-29T11:40:39.000Z" - } - ] - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/apis/{apiId}/versions/{apiVersionId}/{entityType}/{entityId}/syncWithSchema": { - "put": { - "tags": [ - "API", - "Relations" - ], - "summary": "Sync relations with schema", - "description": "This call allows you to keep the relation in sync with the API schema.\n\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "syncRelationsWithSchema", - "responses": { - "200": { - "description": "Successful sync", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - }, - "examples": { - "Successful sync": { - "value": { - "success": true - } - } - } - } - } - }, - "400": { - "description": "Failed to sync", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Unable to validate. Only the OpenAPI 3.0 schema format is supported." - }, - "name": { - "type": "string", - "example": "validationFailed" - } - } - } - } - }, - "examples": { - "Failed to sync": { - "value": { - "error": { - "message": "Unable to validate. Only the OpenAPI 3.0 schema format is supported.", - "name": "validationFailed" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "apiId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "example": "{{apiId}}" - }, - "description": "Id of the API" - }, - { - "name": "apiVersionId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "example": "{{apiVersionId}}" - }, - "description": "Id of the API version" - }, - { - "name": "entityType", - "in": "path", - "required": true, - "schema": { - "type": "string", - "example": "{{entityType}}" - }, - "description": "Relation type (e.g documentation, contracttest, integrationtest, testsuite, mock, monitor)" - }, - { - "name": "entityId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "example": "{{entityId}}" - }, - "description": "Relation id" - } - ] - }, - "/collections": { - "get": { - "tags": [ - "Collections" - ], - "summary": "All Collections", - "description": "The `/collections` endpoint returns a list of all [collections](https://www.getpostman.com/docs/collections) that are accessible by you. The list includes your own collections and the collections that you have subscribed to.\n\nThe response contains an array of collection information containing the `name`, `id`, `owner` and `uid` of each collection.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "allCollections", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "dac5eac9-148d-a32e-b76b-3edee9da28f7" - }, - "name": { - "type": "string", - "example": "Cloud API" - }, - "owner": { - "type": "string", - "example": "631643" - }, - "uid": { - "type": "string", - "example": "631643-dac5eac9-148d-a32e-b76b-3edee9da28f7" - } - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "collections": [ - { - "id": "dac5eac9-148d-a32e-b76b-3edee9da28f7", - "name": "Cloud API", - "owner": "631643", - "uid": "631643-dac5eac9-148d-a32e-b76b-3edee9da28f7" - }, - { - "id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3", - "name": "Sample Collection", - "owner": "631643", - "uid": "631643-f2e66c2e-5297-e4a5-739e-20cbb90900e3" - }, - { - "id": "f695cab7-6878-eb55-7943-ad88e1ccfd65", - "name": "Postman Echo", - "owner": "631643", - "uid": "631643-f695cab7-6878-eb55-7943-ad88e1ccfd65" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Collections" - ], - "summary": "Create Collection", - "description": "This endpoint allows you to create collections using the Postman Collection v2 format. For more information about the v2 schema, check the format [here](https://schema.getpostman.com/json/collection/v2.0.0/docs/index.html).\n\nOn successful creation of the collection, the response returns the collection `name`, `id` and the `uid`.\n\nYou can also specify the context of a workspace to create a collection in directly by passing the `workspace` as a query param.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createCollection", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "info": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "This is just a sample collection." - }, - "name": { - "type": "string", - "example": "Sample Collection {{$randomInt}}" - }, - "schema": { - "type": "string", - "example": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - } - } - }, - "item": { - "type": "array", - "items": { - "type": "object", - "properties": { - "item": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Sample POST Request" - }, - "request": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "mode": { - "type": "string", - "example": "raw" - }, - "raw": { - "type": "string", - "example": "{\"data\": \"123\"}" - } - } - }, - "description": { - "type": "string", - "example": "This is a sample POST Request" - }, - "header": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "Content-Type" - }, - "value": { - "type": "string", - "example": "application/json" - } - } - } - }, - "method": { - "type": "string", - "example": "POST" - }, - "url": { - "type": "string", - "example": "https://postman-echo.com/post" - } - } - } - } - } - }, - "name": { - "type": "string", - "example": "This is a folder" - } - } - } - } - } - } - } - }, - "example": { - "collection": { - "info": { - "description": "This is just a sample collection.", - "name": "Sample Collection {{$randomInt}}", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - }, - "item": [ - { - "item": [ - { - "name": "Sample POST Request", - "request": { - "body": { - "mode": "raw", - "raw": "{\"data\": \"123\"}" - }, - "description": "This is a sample POST Request", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": "https://postman-echo.com/post" - } - } - ], - "name": "This is a folder" - }, - { - "name": "Sample GET Request", - "request": { - "description": "This is a sample GET Request", - "method": "GET", - "url": "https://postman-echo/get" - } - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "Create Collection in a Workspace", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "2412a72c-1d8e-491b-aced-93809c0e94e9" - }, - "name": { - "type": "string", - "example": "Sample Collection" - }, - "uid": { - "type": "string", - "example": "5852-2412a72c-1d8e-491b-aced-93809c0e94e9" - } - } - } - } - }, - "examples": { - "Create Collection in a Workspace": { - "value": { - "collection": { - "id": "2412a72c-1d8e-491b-aced-93809c0e94e9", - "name": "Sample Collection", - "uid": "5852-2412a72c-1d8e-491b-aced-93809c0e94e9" - } - } - } - } - } - } - }, - "400": { - "description": "Malformed Request", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Missing required property: name at info" - }, - "name": { - "type": "string", - "example": "malformedRequestError" - } - } - } - } - }, - "examples": { - "Malformed Request": { - "value": { - "error": { - "message": "Missing required property: name at info", - "name": "malformedRequestError" - } - } - } - } - } - } - } - } - } - }, - "/collections/fork/{collection_uid}": { - "post": { - "tags": [ - "Collections" - ], - "summary": "Create a Fork", - "description": "This endpoint allows you to create a fork from an existing collection.\n\nOn successful creation of the collection, the response returns the collection `name`, `id`, `uid` along with `fork` information.\n\nYou can also specify the context of a workspace to fork a collection in by passing the `workspace` as a query param.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createAFork", - "parameters": [ - { - "name": "workspace", - "in": "query", - "schema": { - "type": "string", - "example": "{{workspace_id}}" - }, - "description": "Workspace ID is required to create a fork" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Fork name" - } - } - }, - "example": { - "name": "Fork name" - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collection_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/collections/merge": { - "post": { - "tags": [ - "Collections" - ], - "summary": "Merge a Fork", - "description": "This endpoint allows you to merge a forked collection back to its destination collection.\n\nOn successful creation of the collection, the response returns the collection `name`, `id` and `uid`.\n\nYou need to specify the fork UID (as `source`) and destination collection UID (as `destination`) in the request body.\n\nOptionally, you can also specify the merge strategy as either `deleteSource` or `updateSourceWithDestination`. Following is an explanation of the merge strategies\n\n| Merge Strategy | Behaviour |\n| --- | --- |\n| deleteSource | Forked collection is deleted after merging |\n| updateSourceWithDestination | Forked collection is up to date with changes in destination collection |\n\nIf the collections cannot be merged (due to conflicts), appropriate error messages will be returned.\n\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "mergeAFork", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "destination": { - "type": "string", - "example": "{{destination_collection_uid}}" - }, - "source": { - "type": "string", - "example": "{{source_collection_uid}}" - }, - "strategy": { - "type": "string", - "example": "deleteSource" - } - } - }, - "example": { - "destination": "{{destination_collection_uid}}", - "source": "{{source_collection_uid}}", - "strategy": "deleteSource" - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/collections/{collection_uid}": { - "get": { - "tags": [ - "Collections" - ], - "summary": "Single Collection ", - "description": "Access the contents of a collection that is accessible to you using its unique id (`uid`).\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleCollection", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "info": { - "type": "object", - "properties": { - "_postman_id": { - "type": "string", - "example": "f2e66c2e-5297-e4a5-739e-20cbb90900e3" - }, - "description": { - "type": "string", - "example": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client." - }, - "name": { - "type": "string", - "example": "Sample Collection" - }, - "schema": { - "type": "string", - "example": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" - } - } - }, - "item": { - "type": "array", - "items": { - "type": "object", - "properties": { - "event": { - "type": "array", - "items": { - "type": "object", - "properties": { - "listen": { - "type": "string", - "example": "test" - }, - "script": { - "type": "object", - "properties": { - "exec": { - "type": "string", - "example": "var responseJSON;\ntry {\n tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n responseJSON = JSON.parse(responseBody);\n tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n" - }, - "type": { - "type": "string", - "example": "text/javascript" - } - } - } - } - } - }, - "id": { - "type": "string", - "example": "82ee981b-e19f-962a-401e-ea34ebfb4848" - }, - "name": { - "type": "string", - "example": "Request Headers" - }, - "request": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "formdata": { - "type": "array", - "items": {} - }, - "mode": { - "type": "string", - "example": "formdata" - } - } - }, - "description": { - "type": "string", - "example": "" - }, - "header": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "" - }, - "key": { - "type": "string", - "example": "my-sample-header" - }, - "value": { - "type": "string", - "example": "Lorem ipsum dolor sit amet" - } - } - } - }, - "method": { - "type": "string", - "example": "GET" - }, - "url": { - "type": "string", - "example": "https://echo.getpostman.com/headers" - } - } - }, - "response": { - "type": "array", - "items": {} - } - } - } - }, - "variables": { - "type": "array", - "items": {} - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "collection": { - "info": { - "_postman_id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3", - "description": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.", - "name": "Sample Collection", - "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" - }, - "item": [ - { - "event": [ - { - "listen": "test", - "script": { - "exec": "var responseJSON;\ntry {\n tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n responseJSON = JSON.parse(responseBody);\n tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n", - "type": "text/javascript" - } - } - ], - "id": "82ee981b-e19f-962a-401e-ea34ebfb4848", - "name": "Request Headers", - "request": { - "body": { - "formdata": [], - "mode": "formdata" - }, - "description": "", - "header": [ - { - "description": "", - "key": "my-sample-header", - "value": "Lorem ipsum dolor sit amet" - } - ], - "method": "GET", - "url": "https://echo.getpostman.com/headers" - }, - "response": [] - } - ], - "variables": [] - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Collections" - ], - "summary": "Update Collection", - "description": "This endpoint allows you to update an existing collection using the Postman Collection v2 format. For more information about the v2 schema, check the format [here](https://schema.getpostman.com/json/collection/v2.0.0/docs/index.html).\n\nOn successful updation of the collection, the response returns the collection `name`, `id` and `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.\n\nNote: Please be careful when trying to update the collection, as the existing collection will be replaced by the request body.", - "operationId": "updateCollection", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "info": { - "type": "object", - "properties": { - "_postman_id": { - "type": "string", - "example": "174bad7c-07e3-45f3-914f-36cf84e5586f" - }, - "description": { - "type": "string", - "example": "This is just a sample collection." - }, - "name": { - "type": "string", - "example": "Sample Collection {{$randomInt}}" - }, - "schema": { - "type": "string", - "example": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - } - } - }, - "item": { - "type": "array", - "items": { - "type": "object", - "properties": { - "item": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Sample POST Request" - }, - "request": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "mode": { - "type": "string", - "example": "raw" - }, - "raw": { - "type": "string", - "example": "{\"data\": \"123\"}" - } - } - }, - "description": { - "type": "string", - "example": "This is a sample POST Request" - }, - "header": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "Content-Type" - }, - "value": { - "type": "string", - "example": "application/json" - } - } - } - }, - "method": { - "type": "string", - "example": "POST" - }, - "url": { - "type": "string", - "example": "https://postman-echo.com/post" - } - } - } - } - } - }, - "name": { - "type": "string", - "example": "This is a folder" - } - } - } - } - } - } - } - }, - "example": { - "collection": { - "info": { - "_postman_id": "174bad7c-07e3-45f3-914f-36cf84e5586f", - "description": "This is just a sample collection.", - "name": "Sample Collection {{$randomInt}}", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - }, - "item": [ - { - "item": [ - { - "name": "Sample POST Request", - "request": { - "body": { - "mode": "raw", - "raw": "{\"data\": \"123\"}" - }, - "description": "This is a sample POST Request", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "method": "POST", - "url": "https://postman-echo.com/post" - } - } - ], - "name": "This is a folder" - }, - { - "name": "Sample GET Request", - "request": { - "description": "This is a sample GET Request", - "method": "GET", - "url": "https://postman-echo/get" - } - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "Collection Updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1d3daef4-2037-4584-ab86-bafd8c8f8a55" - }, - "name": { - "type": "string", - "example": "Sample Collection" - }, - "uid": { - "type": "string", - "example": "5852-1d3daef4-2037-4584-ab86-bafd8c8f8a55" - } - } - } - } - }, - "examples": { - "Collection Updated": { - "value": { - "collection": { - "id": "1d3daef4-2037-4584-ab86-bafd8c8f8a55", - "name": "Sample Collection", - "uid": "5852-1d3daef4-2037-4584-ab86-bafd8c8f8a55" - } - } - } - } - } - } - }, - "400": { - "description": "Collection ID Mismatch", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The collection ID in the path does not match the collection ID in the request body." - }, - "name": { - "type": "string", - "example": "collectionMismatchError" - } - } - } - } - }, - "examples": { - "Collection ID Mismatch": { - "value": { - "error": { - "message": "The collection ID in the path does not match the collection ID in the request body.", - "name": "collectionMismatchError" - } - } - } - } - } - } - }, - "403": { - "description": "Not Enough Permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "You do not have enough permissions to perform this action." - }, - "name": { - "type": "string", - "example": "forbiddenError" - } - } - } - } - }, - "examples": { - "Not Enough Permissions": { - "value": { - "error": { - "message": "You do not have enough permissions to perform this action.", - "name": "forbiddenError" - } - } - } - } - } - } - }, - "404": { - "description": "Collection Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "details": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1d3daef4-2037-4584-ab86-bafd8c8f8a54" - }, - "item": { - "type": "string", - "example": "collection" - } - } - }, - "message": { - "type": "string", - "example": "The specified item does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Collection Not Found": { - "value": { - "error": { - "details": { - "id": "1d3daef4-2037-4584-ab86-bafd8c8f8a54", - "item": "collection" - }, - "message": "The specified item does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Collections" - ], - "summary": "Delete Collection", - "description": "This endpoint allows you to delete an existing collection.\n\nOn successful deletion of the collection, the response returns the `id` and `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteCollection", - "responses": { - "200": { - "description": "Collection Deleted", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "a14c6da7-afba-4a84-bf22-4febbaaced6c" - }, - "uid": { - "type": "string", - "example": "5852-a14c6da7-afba-4a84-bf22-4febbaaced6c" - } - } - } - } - }, - "examples": { - "Collection Deleted": { - "value": { - "collection": { - "id": "a14c6da7-afba-4a84-bf22-4febbaaced6c", - "uid": "5852-a14c6da7-afba-4a84-bf22-4febbaaced6c" - } - } - } - } - } - } - }, - "404": { - "description": "Collection Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "details": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "a14c6da7-afba-4a84-bf22-4febbaaced6c" - }, - "item": { - "type": "string", - "example": "collection" - } - } - }, - "message": { - "type": "string", - "example": "The specified item does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Collection Not Found": { - "value": { - "error": { - "details": { - "id": "a14c6da7-afba-4a84-bf22-4febbaaced6c", - "item": "collection" - }, - "message": "The specified item does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "collection_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/environments": { - "get": { - "tags": [ - "Environments" - ], - "summary": "All Environments", - "description": "The `/environments` endpoint returns a list of all [environments](https://www.getpostman.com/docs/environments) that belong to you..\n\nThe response contains an array of environments' information containing the `name`, `id`, `owner` and `uid` of each environment.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "allEnvironments", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "357668d2-84f1-2264-438b-113095359f80" - }, - "name": { - "type": "string", - "example": "Postman Cloud API" - }, - "owner": { - "type": "string", - "example": "631643" - }, - "uid": { - "type": "string", - "example": "631643-357668d2-84f1-2264-438b-113095359f80" - } - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "environments": [ - { - "id": "357668d2-84f1-2264-438b-113095359f80", - "name": "Postman Cloud API", - "owner": "631643", - "uid": "631643-357668d2-84f1-2264-438b-113095359f80" - }, - { - "id": "84a119b6-f4b1-9120-5f11-a73b17818d70", - "name": "Postman Cloud API.template", - "owner": "631643", - "uid": "631643-84a119b6-f4b1-9120-5f11-a73b17818d70" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Environments" - ], - "summary": "Create Environment", - "description": "A sample body is added to the request that conforms to the following JSON schema:\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 254,\n \"minLength\": 1\n },\n \"values\": {\n \"type\": \"array\",\n \"maxItems\": 100,\n \"additionalItems\": false,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"maxLength\": 254\n \"minLength\": 1\n },\n \"value\": { \"type\": \"string\" },\n \"enabled\": { \"type\": \"boolean\" }\n },\n \"required\": [\"key\", \"value\"]\n }\n }\n },\n \"required\": [\"name\"]\n }\n },\n \"required\": [\"environment\"]\n}\n```\n\nOn successful creation of the environment, the API returns the environment name and `id`.\n\nYou can also specify the context of a workspace to create an environment in directly by passing the `workspace` as a query param.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createEnvironment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Sample Environment Name (required)" - }, - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "variable_name_1" - }, - "value": { - "type": "string", - "example": "The value of the variable" - } - } - } - } - } - } - } - }, - "example": { - "environment": { - "name": "Sample Environment Name (required)", - "values": [ - { - "key": "variable_name_1", - "value": "The value of the variable" - }, - { - "key": "variable_name_2", - "value": "" - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "f158266e-306b-4702-a2b9-e4ede7878b7a" - }, - "name": { - "type": "string", - "example": "Sample Environment Name (required)" - }, - "uid": { - "type": "string", - "example": "5665-f158266e-306b-4702-a2b9-e4ede7878b7a" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "environment": { - "id": "f158266e-306b-4702-a2b9-e4ede7878b7a", - "name": "Sample Environment Name (required)", - "uid": "5665-f158266e-306b-4702-a2b9-e4ede7878b7a" - } - } - } - } - } - } - }, - "400": { - "description": "Failure Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Missing required property: environment" - }, - "name": { - "type": "string", - "example": "malformedRequestError" - } - } - } - } - }, - "examples": { - "Failure Response": { - "value": { - "error": { - "message": "Missing required property: environment", - "name": "malformedRequestError" - } - } - } - } - } - } - } - } - } - }, - "/environments/{environment_uid}": { - "get": { - "tags": [ - "Environments" - ], - "summary": "Single Environment", - "description": "Access the contents of an environment that is accessible to you using its unique id (`uid`).\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleEnvironment", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "84a119b6-f4b1-9120-5f11-a73b17818d70" - }, - "name": { - "type": "string", - "example": "Postman Cloud API.template" - }, - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "example": true - }, - "hovered": { - "type": "boolean", - "example": false - }, - "key": { - "type": "string", - "example": "postman_api_key" - }, - "type": { - "type": "string", - "example": "text" - }, - "value": { - "type": "string", - "example": "" - } - } - } - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "environment": { - "id": "84a119b6-f4b1-9120-5f11-a73b17818d70", - "name": "Postman Cloud API.template", - "values": [ - { - "enabled": true, - "hovered": false, - "key": "postman_api_key", - "type": "text", - "value": "" - } - ] - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Environments" - ], - "summary": "Update Environment", - "description": "This endpoint replaces an existing environment.\n\nA sample body is added to the request that conforms to the following JSON schema:\n\n```json\n{\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"environment\": {\n\t\t\t\"type\": \"object\",\n\t\t\t\"properties\": {\n\t\t\t\t\"name\": {\n\t\t\t\t\t\"type\": \"string\",\n\t\t\t\t\t\"maxLength\": 254,\n\t\t\t\t\t\"minLength\": 1\n\t\t\t\t},\n\t\t\t\t\"values\": {\n\t\t\t\t\t\"type\": \"array\",\n\t\t\t\t\t\"maxItems\": 100,\n\t\t\t\t\t\"additionalItems\": false,\n\t\t\t\t\t\"items\": {\n\t\t\t\t\t\t\"type\": \"object\",\n\t\t\t\t\t\t\"properties\": {\n\t\t\t\t\t\t\t\"key\": {\n\t\t\t\t\t\t\t\t\"type\": \"string\",\n\t\t\t\t\t\t\t\t\"maxLength\": 254,\n\t\t\t\t\t\t\t\t\"minLength\": 1\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"value\": {\n\t\t\t\t\t\t\t\t\"type\": \"string\",\n\t\t\t\t\t\t\t\t\"maxLength\": 254,\n\t\t\t\t\t\t\t\t\"minLength\": 1\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\"type\": \"string\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"enabled\": {\n\t\t\t\t\t\t\t\t\"type\": \"boolean\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"required\": [\n\t\t\t\t\t\t\t\"key\",\n\t\t\t\t\t\t\t\"value\"\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t},\n\t\"required\": [\n\t\t\"environment\"\n\t]\n}\n```\n\nOn successful updation of the environment, the API returns the environment name and `id`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateEnvironment", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "New Name" - }, - "values": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "name" - }, - "value": { - "type": "string", - "example": "Bruce Wayne" - } - } - } - } - } - } - } - }, - "example": { - "environment": { - "name": "New Name", - "values": [ - { - "key": "name", - "value": "Bruce Wayne" - }, - { - "key": "occupation", - "value": "Vigilante" - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "357668d2-84f1-2264-438b-113095359f80" - }, - "name": { - "type": "string", - "example": "New Name" - }, - "uid": { - "type": "string", - "example": "631643-357668d2-84f1-2264-438b-113095359f80" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "environment": { - "id": "357668d2-84f1-2264-438b-113095359f80", - "name": "New Name", - "uid": "631643-357668d2-84f1-2264-438b-113095359f80" - } - } - } - } - } - } - }, - "400": { - "description": "Failure Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Invalid type: null (expected object) at environment.values.0" - }, - "name": { - "type": "string", - "example": "malformedRequestError" - } - } - } - } - }, - "examples": { - "Failure Response": { - "value": { - "error": { - "message": "Invalid type: null (expected object) at environment.values.0", - "name": "malformedRequestError" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Environments" - ], - "summary": "Delete Environment", - "description": "This endpoint allows you to delete a single environment based on an environment's unique `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteEnvironment", - "responses": { - "200": { - "description": "Environment Deleted", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "environment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce" - }, - "uid": { - "type": "string", - "example": "5852-4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce" - } - } - } - } - }, - "examples": { - "Environment Deleted": { - "value": { - "environment": { - "id": "4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce", - "uid": "5852-4dfb28a4-9a6c-4ce4-b31a-17c26a8b2cce" - } - } - } - } - } - } - }, - "404": { - "description": "Environment Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The specified environment does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Environment Not Found": { - "value": { - "error": { - "message": "The specified environment does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "environment_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/import/exported": { - "post": { - "tags": [ - "Import" - ], - "summary": "Import exported data", - "description": "This endpoint allows you to import your exported Postman data.\nFor more information about how you can export your data, refer Export your Postman data.\n\nOn successful imports, the response will be an array with Each element contaning `id`, `name` and `uid` of entities created.\n\n**Note**: Refer to examples for different scenarios.\n\n> Requires API Key as `X-Api-Key` request header.", - "operationId": "importExportedData", - "requestBody": { - "content": { - "application/octet-stream": {} - } - }, - "responses": { - "200": { - "description": "Success: Import to a specific workspace with workspace ID passed as a query parameter", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "b31be584-1b1e-4444-b581-761edf88fe77" - }, - "name": { - "type": "string", - "example": "Swagger Petstore" - }, - "uid": { - "type": "string", - "example": "2282-b31be584-1b1e-4444-b581-761edf88fe77" - } - } - } - } - } - }, - "examples": { - "Success: Import to a specific workspace with workspace ID passed as a query parameter": { - "value": { - "collections": [ - { - "id": "b31be584-1b1e-4444-b581-761edf88fe77", - "name": "Swagger Petstore", - "uid": "2282-b31be584-1b1e-4444-b581-761edf88fe77" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Error: Param Missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "details": { - "type": "object", - "properties": { - "param": { - "type": "string", - "example": "type" - } - } - }, - "message": { - "type": "string", - "example": "The request body is missing a value for the type parameter. Check your request and try again." - }, - "name": { - "type": "string", - "example": "paramMissingError" - } - } - } - } - }, - "examples": { - "Error: Param Missing": { - "value": { - "error": { - "details": { - "param": "type" - }, - "message": "The request body is missing a value for the type parameter. Check your request and try again.", - "name": "paramMissingError" - } - } - } - } - } - } - } - } - } - }, - "/import/openapi": { - "post": { - "tags": [ - "Import" - ], - "summary": "Import external API specification", - "description": "This endpoint allows you to import external API specifications into Postman.\n\nCurrently, this endpoint only supports the OpenAPI specification, for which the `importType` will be `openapi`.\n\nOn a successful import, the response will be an array with each element contaning `id`, `name` and `uid` of entities created.\n\nSupported `type`s:\n\n- string\n- json\n- file\n\nThe `input` parameter should be defined based on the `type`.\n\n> To import a file, request body must be form-data with `type` param set to `file`.\n\n**Note**: Refer to examples for different scenarios.\n\n> Requires API Key as `X-Api-Key` request header.", - "operationId": "importExternalApiSpecification", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "input": { - "type": "object", - "properties": { - "info": { - "type": "object", - "properties": { - "license": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "MIT" - } - } - }, - "title": { - "type": "string", - "example": "Swagger Petstore" - }, - "version": { - "type": "string", - "example": "1.0.0" - } - } - }, - "openapi": { - "type": "string", - "example": "3.0.0" - }, - "paths": { - "type": "object", - "properties": { - "/pets": { - "type": "object", - "properties": { - "get": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "example": "listPets" - }, - "parameters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "limit" - }, - "in": { - "type": "string", - "example": "query" - }, - "name": { - "type": "string", - "example": "limit" - }, - "required": { - "type": "boolean", - "example": false - }, - "schema": { - "type": "object", - "properties": { - "format": { - "type": "string", - "example": "int32" - }, - "type": { - "type": "string", - "example": "integer" - } - } - } - } - } - }, - "responses": { - "type": "object", - "properties": { - "default": { - "type": "object", - "properties": { - "content": { - "type": "object", - "properties": { - "application/json": { - "type": "object", - "properties": { - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "code": { - "type": "object", - "properties": { - "format": { - "type": "string", - "example": "int32" - }, - "type": { - "type": "string", - "example": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "string" - } - } - } - } - }, - "required": { - "type": "array", - "items": { - "type": "string", - "example": "code" - } - } - } - } - } - } - } - }, - "description": { - "type": "string", - "example": "unexpected error" - } - } - } - } - }, - "summary": { - "type": "string", - "example": "List all pets" - } - } - } - } - } - } - }, - "servers": { - "type": "array", - "items": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "http://petstore.swagger.io/v1" - } - } - } - } - } - }, - "type": { - "type": "string", - "example": "json" - } - } - }, - "example": { - "input": { - "info": { - "license": { - "name": "MIT" - }, - "title": "Swagger Petstore", - "version": "1.0.0" - }, - "openapi": "3.0.0", - "paths": { - "/pets": { - "get": { - "operationId": "listPets", - "parameters": [ - { - "description": "limit", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "default": { - "content": { - "application/json": { - "schema": { - "properties": { - "code": { - "format": "int32", - "type": "integer" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message" - ] - } - } - }, - "description": "unexpected error" - } - }, - "summary": "List all pets" - } - } - }, - "servers": [ - { - "url": "http://petstore.swagger.io/v1" - } - ] - }, - "type": "json" - } - } - } - }, - "responses": { - "200": { - "description": "Success: Import to a specific workspace with workspace ID passed as a query parameter", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "b31be584-1b1e-4444-b581-761edf88fe77" - }, - "name": { - "type": "string", - "example": "Swagger Petstore" - }, - "uid": { - "type": "string", - "example": "2282-b31be584-1b1e-4444-b581-761edf88fe77" - } - } - } - } - } - }, - "examples": { - "Success: Import to a specific workspace with workspace ID passed as a query parameter": { - "value": { - "collections": [ - { - "id": "b31be584-1b1e-4444-b581-761edf88fe77", - "name": "Swagger Petstore", - "uid": "2282-b31be584-1b1e-4444-b581-761edf88fe77" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Error: Param Missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "details": { - "type": "object", - "properties": { - "param": { - "type": "string", - "example": "type" - } - } - }, - "message": { - "type": "string", - "example": "The request body is missing a value for the type parameter. Check your request and try again." - }, - "name": { - "type": "string", - "example": "paramMissingError" - } - } - } - } - }, - "examples": { - "Error: Param Missing": { - "value": { - "error": { - "details": { - "param": "type" - }, - "message": "The request body is missing a value for the type parameter. Check your request and try again.", - "name": "paramMissingError" - } - } - } - } - } - } - } - } - } - }, - "/me": { - "get": { - "tags": [ - "User" - ], - "summary": "API Key Owner", - "description": "the `/me` Postman API endpoint lets you access information about the authenticated user. You can retrieve the authenticated user's username, full name, e-mail address, and any other available information.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "apiKeyOwner", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "limit": { - "type": "number", - "example": 1000000 - }, - "name": { - "type": "string", - "example": "mock_usage" - }, - "overage": { - "type": "number", - "example": 0 - }, - "usage": { - "type": "number", - "example": 2382 - } - } - } - }, - "user": { - "type": "object", - "properties": { - "avatar": { - "type": "string", - "example": "https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6" - }, - "email": { - "type": "string", - "example": "janedoe@example.com" - }, - "fullName": { - "type": "string", - "example": "Jane Doe" - }, - "id": { - "type": "string", - "example": "631643" - }, - "isPublic": { - "type": "boolean", - "example": false - }, - "username": { - "type": "string", - "example": "janedoe" - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "operations": [ - { - "limit": 1000000, - "name": "mock_usage", - "overage": 0, - "usage": 2382 - }, - { - "limit": 10000000, - "name": "monitor_request_runs", - "overage": 0, - "usage": 49492 - }, - { - "limit": 5000000, - "name": "documenter_public_views", - "overage": 0, - "usage": 120232 - }, - { - "limit": 1000000, - "name": "api_usage", - "overage": 0, - "usage": 1345 - }, - { - "limit": 25, - "name": "custom_domains", - "overage": 0, - "usage": 1 - }, - { - "limit": 1, - "name": "custom_authentication_methods", - "overage": 0, - "usage": 1 - }, - { - "limit": 10000, - "name": "serverless_requests", - "overage": 0, - "usage": 0 - }, - { - "limit": 5000, - "name": "integrations", - "overage": 0, - "usage": 145 - }, - { - "limit": 1000000, - "name": "cloud_agent_requests", - "overage": 0, - "usage": 23823 - } - ], - "user": { - "avatar": "https://www.gravatar.com/avatar/e1f3994f2632af3d1c8c2dcc168a10e6", - "email": "janedoe@example.com", - "fullName": "Jane Doe", - "id": "631643", - "isPublic": false, - "username": "janedoe" - } - } - } - } - } - } - } - } - } - }, - "/mocks": { - "get": { - "tags": [ - "Mocks" - ], - "summary": "All Mocks", - "description": "This endpoint fetches all the mocks that you have created.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "allMocks", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mocks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc" - }, - "environment": { - "type": "string", - "example": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524" - }, - "id": { - "type": "string", - "example": "0fca2246-c108-41f5-8454-cc032def329f" - }, - "mockUrl": { - "type": "string", - "example": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io" - }, - "owner": { - "type": "string", - "example": "1679925" - }, - "uid": { - "type": "string", - "example": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "mocks": [ - { - "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc", - "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524", - "id": "0fca2246-c108-41f5-8454-cc032def329f", - "mockUrl": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io", - "owner": "1679925", - "uid": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - }, - { - "collection": "1679925-37294bb0-e27b-5e52-93ae-c07dd445216d", - "id": "2c624389-705a-4e66-9777-05314b431796", - "mockUrl": "https://2c624389-705a-4e66-9777-05314b431796.mock.pstmn.io", - "owner": "1679925", - "uid": "1679925-2c624389-705a-4e66-9777-05314b431796" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Mocks" - ], - "summary": "Create Mock", - "description": "This endpoint allows you to create a mock on a collection. You can also provide an environment UID to resolve any environment variables in the collection.\n\nYou can also specify the context of a workspace to create a mock in directly by passing the `workspace` as a query param.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createMock", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc" - }, - "environment": { - "type": "string", - "example": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524" - } - } - } - } - }, - "example": { - "mock": { - "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc", - "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524" - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc" - }, - "environment": { - "type": "string", - "example": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524" - }, - "id": { - "type": "string", - "example": "0fca2246-c108-41f5-8454-cc032def329f" - }, - "mockUrl": { - "type": "string", - "example": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io" - }, - "owner": { - "type": "string", - "example": "1679925" - }, - "uid": { - "type": "string", - "example": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "mock": { - "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc", - "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524", - "id": "0fca2246-c108-41f5-8454-cc032def329f", - "mockUrl": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io", - "owner": "1679925", - "uid": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - } - } - } - } - } - }, - "/mocks/{mock_uid}": { - "get": { - "tags": [ - "Mocks" - ], - "summary": "Single Mock", - "description": "This endpoint fetches you the basic information about a single mock using its `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleMock", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc" - }, - "environment": { - "type": "string", - "example": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524" - }, - "id": { - "type": "string", - "example": "0fca2246-c108-41f5-8454-cc032def329f" - }, - "mockUrl": { - "type": "string", - "example": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io" - }, - "owner": { - "type": "string", - "example": "1679925" - }, - "uid": { - "type": "string", - "example": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "mock": { - "collection": "1679925-39fee52f-b806-3ffa-1173-00a6f5b183dc", - "environment": "1679925-0b9e9f15-3208-a2b1-22e0-d58392f01524", - "id": "0fca2246-c108-41f5-8454-cc032def329f", - "mockUrl": "https://0fca2246-c108-41f5-8454-cc032def329f.mock.pstmn.io", - "owner": "1679925", - "uid": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Mocks" - ], - "summary": "Update Mock", - "description": "This endpoint allows you to update a mock you have created using its `uid`. The endpoint allows you to edit fields,\n* name\n* environment\n* description\n* private\n* versionTag\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateMock", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "example describing update mock description" - }, - "environment": { - "type": "string", - "example": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19" - }, - "name": { - "type": "string", - "example": "My Mock Server" - }, - "private": { - "type": "boolean", - "example": false - }, - "versionTag": { - "type": "string", - "example": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec" - } - } - } - } - }, - "example": { - "mock": { - "description": "example describing update mock description", - "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19", - "name": "My Mock Server", - "private": false, - "versionTag": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec" - } - } - } - } - }, - "responses": { - "200": { - "description": "success Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "11582779-fd6797e2-de6b-4699-975c-85290e4c2499" - }, - "config": { - "type": "object", - "properties": { - "headers": { - "type": "array", - "items": {} - }, - "matchBody": { - "type": "boolean", - "example": false - }, - "matchQueryParams": { - "type": "boolean", - "example": true - }, - "matchWildcards": { - "type": "boolean", - "example": true - } - } - }, - "environment": { - "type": "string", - "example": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19" - }, - "id": { - "type": "string", - "example": "06040138-dd6b-4cce-9a02-7e1c1ab59723" - }, - "mockUrl": { - "type": "string", - "example": "https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io" - }, - "name": { - "type": "string", - "example": "My Mock Server" - }, - "owner": { - "type": "string", - "example": "11582779" - }, - "uid": { - "type": "string", - "example": "11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - }, - "examples": { - "success Response": { - "value": { - "mock": { - "collection": "11582779-fd6797e2-de6b-4699-975c-85290e4c2499", - "config": { - "headers": [], - "matchBody": false, - "matchQueryParams": true, - "matchWildcards": true - }, - "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19", - "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723", - "mockUrl": "https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io", - "name": "My Mock Server", - "owner": "11582779", - "uid": "11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Mocks" - ], - "summary": "Delete Mock", - "description": "This endpoint allows you to delete an existing mock using its `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteMock", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "0fca2246-c108-41f5-8454-cc032def329f" - }, - "uid": { - "type": "string", - "example": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "mock": { - "id": "0fca2246-c108-41f5-8454-cc032def329f", - "uid": "1679925-0fca2246-c108-41f5-8454-cc032def329f" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "mock_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/mocks/{mock_uid}/publish": { - "post": { - "tags": [ - "Mocks" - ], - "summary": "Publish Mock", - "description": "This endpoint publishes the mock you have created using its `uid`\n\n> Requires API Key as `X-Api-Key ` request header or `apikey` URL query parameter.", - "operationId": "publishMock", - "responses": { - "200": { - "description": "Success Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - }, - "examples": { - "Success Response": { - "value": { - "mock": { - "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "mock_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/mocks/{mock_uid}/unpublish": { - "delete": { - "tags": [ - "Mocks" - ], - "summary": "Unpublish Mock", - "description": "This endpoint unpublishes the mock you have created using its `uid`\n\n> Requires API Key as `X-Api-Key ` request header or `apikey` URL query parameter.", - "operationId": "unpublishMock", - "responses": { - "200": { - "description": "Success Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mock": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - }, - "examples": { - "Success Response": { - "value": { - "mock": { - "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "mock_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/monitors": { - "get": { - "tags": [ - "Monitors" - ], - "summary": "All Monitors", - "description": "The `/monitors` endpoint returns a list of all [monitors](https://monitor.getpostman.com/) that are accessible by you.\n\nThe response contains an array of monitors information containing the `name`, `id`, `owner` and `uid` of each monitor.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "allMonitors", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e6b6c77-2031-42d0-9948-76d7251b2dd1" - }, - "name": { - "type": "string", - "example": "Batman & Sherlock Holmes Monitor" - }, - "owner": { - "type": "string", - "example": "5852" - }, - "uid": { - "type": "string", - "example": "5852-1e6b6c77-2031-42d0-9948-76d7251b2dd1" - } - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "monitors": [ - { - "id": "1e6b6c77-2031-42d0-9948-76d7251b2dd1", - "name": "Batman & Sherlock Holmes Monitor", - "owner": "5852", - "uid": "5852-1e6b6c77-2031-42d0-9948-76d7251b2dd1" - }, - { - "id": "1e6b6cb7-f13d-4000-acb7-0695757174a8", - "name": "Team Level Monitor", - "owner": "5886", - "uid": "5886-1e6b6cb7-f13d-4000-acb7-0695757174a8" - }, - { - "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1", - "name": "Postman Echo Monitor", - "owner": "5852", - "uid": "5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Monitors" - ], - "summary": "Create Monitor", - "description": "This endpoint allows you to create a monitor.\n\nSome sample `cron` values are:\n\n| Frequency | Cron Pattern |\n|-----------------------|----------------|\n| Every 5 minutes | `*/5 * * * *` |\n| Every 30 minutes | `*/30 * * * *` |\n| Every Hour | `0 */1 * * *` |\n| Every 6 Hours | `0 */6 * * *` |\n| Every day at 5pm | `0 17 * * *` |\n| Every Monday at 12pm | `0 12 * * MON` |\n| Every weekday (Monday - Friday) at 6am | `0 6 * * MON-FRI` |\n\nNote: Currently, you can only create monitors at some limited schedules. You can head to [Postman Monitors](https://monitor.getpostman.com) to see the allowed schedules. \n\nFor more information about the format of the `timezone` value, check this [list of time zones.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n\nYou can also specify the context of a workspace to create a monitor in directly by passing the `workspace` as a query param.\n\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createMonitor", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "5852-8d05dd85-222c-1452-553b-e76a531b71ed" - }, - "environment": { - "type": "string", - "example": "5852-8a4c21ea-2a36-40d1-a82d-d717fac9d6ef" - }, - "name": { - "type": "string", - "example": "This is a Monitor Name" - }, - "schedule": { - "type": "object", - "properties": { - "cron": { - "type": "string", - "example": "0 0 * * *" - }, - "timezone": { - "type": "string", - "example": "Asia/Kolkata" - } - } - } - } - } - } - }, - "example": { - "monitor": { - "collection": "5852-8d05dd85-222c-1452-553b-e76a531b71ed", - "environment": "5852-8a4c21ea-2a36-40d1-a82d-d717fac9d6ef", - "name": "This is a Monitor Name", - "schedule": { - "cron": "0 0 * * *", - "timezone": "Asia/Kolkata" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Create Monitor in a Workspace", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e6b6dfd-7ba4-4590-9ee1-5948102d7797" - }, - "name": { - "type": "string", - "example": "Monitor Name" - }, - "uid": { - "type": "string", - "example": "5852-1e6b6dfd-7ba4-4590-9ee1-5948102d7797" - } - } - } - } - }, - "examples": { - "Create Monitor in a Workspace": { - "value": { - "monitor": { - "id": "1e6b6dfd-7ba4-4590-9ee1-5948102d7797", - "name": "Monitor Name", - "uid": "5852-1e6b6dfd-7ba4-4590-9ee1-5948102d7797" - } - } - } - } - } - } - }, - "400": { - "description": "Parameter Missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "details": { - "type": "object", - "properties": { - "param": { - "type": "string", - "example": "monitor" - } - } - }, - "message": { - "type": "string", - "example": "Parameter is missing in the request." - }, - "name": { - "type": "string", - "example": "paramMissingError" - } - } - } - } - }, - "examples": { - "Parameter Missing": { - "value": { - "error": { - "details": { - "param": "monitor" - }, - "message": "Parameter is missing in the request.", - "name": "paramMissingError" - } - } - } - } - } - } - } - } - } - }, - "/monitors/{monitor_uid}": { - "get": { - "tags": [ - "Monitors" - ], - "summary": "Single Monitor", - "description": "This endpoint fetches you basic information about the monitor using its `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleMonitor", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "collectionUid": { - "type": "string", - "example": "5852-8d05dd85-222c-1452-553b-e76a531b71ed" - }, - "distribution": { - "type": "array", - "items": {} - }, - "environmentUid": { - "type": "string", - "example": "5851-8d05dd85-222c-1452-553b-e76a531b71ed" - }, - "id": { - "type": "string", - "example": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1" - }, - "lastRun": { - "type": "object", - "properties": { - "finishedAt": { - "type": "string", - "example": "2020-03-25T15:45:31.340Z" - }, - "startedAt": { - "type": "string", - "example": "2020-03-25T15:45:29.218Z" - }, - "stats": { - "type": "object", - "properties": { - "assertions": { - "type": "object", - "properties": { - "failed": { - "type": "number", - "example": 1 - }, - "total": { - "type": "number", - "example": 8 - } - } - }, - "requests": { - "type": "object", - "properties": { - "total": { - "type": "number", - "example": 4 - } - } - } - } - }, - "status": { - "type": "string", - "example": "failed" - } - } - }, - "name": { - "type": "string", - "example": "Postman Echo Monitor" - }, - "notifications": { - "type": "object", - "properties": { - "onError": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "john.appleseed@example.com" - } - } - } - }, - "onFailure": { - "type": "array", - "items": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "john.appleseed@example.com" - } - } - } - } - } - }, - "options": { - "type": "object", - "properties": { - "followRedirects": { - "type": "boolean", - "example": true - }, - "requestDelay": { - "type": "number", - "example": 0 - }, - "requestTimeout": { - "type": "number", - "example": 3000 - }, - "strictSSL": { - "type": "boolean", - "example": true - } - } - }, - "owner": { - "type": "string", - "example": "5852" - }, - "schedule": { - "type": "object", - "properties": { - "cron": { - "type": "string", - "example": "0 0 * * * *" - }, - "nextRun": { - "type": "string", - "example": "2016-11-30T09:30:00.000Z" - }, - "timezone": { - "type": "string", - "example": "Asia/Calcutta" - } - } - }, - "uid": { - "type": "string", - "example": "5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "monitor": { - "collectionUid": "5852-8d05dd85-222c-1452-553b-e76a531b71ed", - "distribution": [], - "environmentUid": "5851-8d05dd85-222c-1452-553b-e76a531b71ed", - "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1", - "lastRun": { - "finishedAt": "2020-03-25T15:45:31.340Z", - "startedAt": "2020-03-25T15:45:29.218Z", - "stats": { - "assertions": { - "failed": 1, - "total": 8 - }, - "requests": { - "total": 4 - } - }, - "status": "failed" - }, - "name": "Postman Echo Monitor", - "notifications": { - "onError": [ - { - "email": "john.appleseed@example.com" - } - ], - "onFailure": [ - { - "email": "john.appleseed@example.com" - } - ] - }, - "options": { - "followRedirects": true, - "requestDelay": 0, - "requestTimeout": 3000, - "strictSSL": true - }, - "owner": "5852", - "schedule": { - "cron": "0 0 * * * *", - "nextRun": "2016-11-30T09:30:00.000Z", - "timezone": "Asia/Calcutta" - }, - "uid": "5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1" - } - } - } - } - } - } - }, - "404": { - "description": "Monitor Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The specified monitor does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Monitor Not Found": { - "value": { - "error": { - "message": "The specified monitor does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Monitors" - ], - "summary": "Update Monitor", - "description": "This endpoint allows you to update a monitor using its `uid`. Only the monitor name and its schedule can be updated.\n\nSome example `cron` values are:\n\n| Frequency | Cron Pattern |\n|-----------------------|----------------|\n| Every 5 minutes | `*/5 * * * *` |\n| Every 30 minutes | `*/30 * * * *` |\n| Every Hour | `0 */1 * * *` |\n| Every 6 Hours | `0 */6 * * *` |\n| Every day at 5pm | `0 17 * * *` |\n| Every Monday at 12pm | `0 12 * * MON` |\n| Every weekday (Monday - Friday) at 6am | `0 6 * * MON-FRI` |\n\nNote: Currently, you can only create monitors at some limited schedules. You can head to [Postman Monitors](https://monitor.getpostman.com) to see the allowed schedules. \n\nFor more information about the format of the `timezone` value, check this [list of time zones.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "updateMonitor", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Updated Monitor Name" - }, - "schedule": { - "type": "object", - "properties": { - "cron": { - "type": "string", - "example": "*/5 * * * *" - }, - "timezone": { - "type": "string", - "example": "America/Chicago" - } - } - } - } - } - } - }, - "example": { - "monitor": { - "name": "Updated Monitor Name", - "schedule": { - "cron": "*/5 * * * *", - "timezone": "America/Chicago" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Monitor Updated", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e6b6e2a-c2ad-4090-b750-0df4e6624352" - }, - "name": { - "type": "string", - "example": "Updated Monitor Name" - }, - "uid": { - "type": "string", - "example": "5852-1e6b6e2a-c2ad-4090-b750-0df4e6624352" - } - } - } - } - }, - "examples": { - "Monitor Updated": { - "value": { - "monitor": { - "id": "1e6b6e2a-c2ad-4090-b750-0df4e6624352", - "name": "Updated Monitor Name", - "uid": "5852-1e6b6e2a-c2ad-4090-b750-0df4e6624352" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Monitors" - ], - "summary": "Delete Monitor", - "description": "This endpoint can be used to delete an existing monitor using its `uid`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteMonitor", - "responses": { - "200": { - "description": "Monitor Deleted", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "monitor": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e6b8957-35f9-42a0-8d2f-f03d7085b3d2" - }, - "uid": { - "type": "string", - "example": "5852-1e6b8957-35f9-42a0-8d2f-f03d7085b3d2" - } - } - } - } - }, - "examples": { - "Monitor Deleted": { - "value": { - "monitor": { - "id": "1e6b8957-35f9-42a0-8d2f-f03d7085b3d2", - "uid": "5852-1e6b8957-35f9-42a0-8d2f-f03d7085b3d2" - } - } - } - } - } - } - }, - "404": { - "description": "Monitor Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The specified monitor does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Monitor Not Found": { - "value": { - "error": { - "message": "The specified monitor does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "monitor_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/monitors/{monitor_uid}/run": { - "post": { - "tags": [ - "Monitors" - ], - "summary": "Run a Monitor", - "description": "This endpoint will run the monitor instantly and wait for the monitor to run completely. It responds with the run results.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "runAMonitor", - "responses": { - "200": { - "description": "Monitor Run with Errors", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "run": { - "type": "object", - "properties": { - "executions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 1 - }, - "item": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "b5e8d7dd-909c-4ba7-aef4-8609bc50b586" - }, - "name": { - "type": "string", - "example": "Sample POST Request" - } - } - }, - "request": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "contentLength": { - "type": "number", - "example": 18 - }, - "mode": { - "type": "string", - "example": "raw" - } - } - }, - "headers": { - "type": "object", - "properties": { - "accept": { - "type": "string", - "example": "*/*" - }, - "accept-encoding": { - "type": "string", - "example": "gzip, deflate" - }, - "content-length": { - "type": "number", - "example": 18 - }, - "content-type": { - "type": "string", - "example": "application/json" - } - } - }, - "method": { - "type": "string", - "example": "POST" - }, - "timestamp": { - "type": "string", - "example": "2016-12-04T14:30:26.025Z" - }, - "url": { - "type": "string", - "example": "echo.getpostman.com/post" - } - } - }, - "response": { - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "contentLength": { - "type": "number", - "example": 298 - } - } - }, - "code": { - "type": "number", - "example": 200 - }, - "headers": { - "type": "object", - "properties": { - "connection": { - "type": "string", - "example": "keep-alive" - }, - "content-encoding": { - "type": "string", - "example": "gzip" - }, - "content-type": { - "type": "string", - "example": "application/json" - }, - "date": { - "type": "string", - "example": "Sun, 04 Dec 2016 14:30:26 GMT" - }, - "transfer-encoding": { - "type": "string", - "example": "chunked" - } - } - }, - "responseSize": { - "type": "number", - "example": 298 - }, - "responseTime": { - "type": "number", - "example": 26 - } - } - } - } - } - }, - "failures": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assertion": { - "type": "object", - "properties": { - "Status code is 400": { - "type": "boolean", - "example": false - } - } - }, - "executionId": { - "type": "number", - "example": 2 - }, - "message": { - "type": "string", - "example": "Expected 'Status code is 400' to be truthy" - }, - "name": { - "type": "string", - "example": "AssertionError" - } - } - } - }, - "info": { - "type": "object", - "properties": { - "collectionUid": { - "type": "string", - "example": "5852-1d3daef4-2037-4584-ab86-bafd8c8f8a55" - }, - "finishedAt": { - "type": "string", - "example": "2016-12-04T14:30:26.000Z" - }, - "jobId": { - "type": "string", - "example": "1e6ba2e3-1aaf-4c10-bd5f-905943284b2a" - }, - "monitorId": { - "type": "string", - "example": "1e6b8970-fd13-4480-b011-b3b3e3cd271d" - }, - "name": { - "type": "string", - "example": "Sample Collection monitor 1 #56" - }, - "startedAt": { - "type": "string", - "example": "2016-12-04T14:30:25.000Z" - }, - "status": { - "type": "string", - "example": "failed" - } - } - }, - "stats": { - "type": "object", - "properties": { - "assertions": { - "type": "object", - "properties": { - "failed": { - "type": "number", - "example": 1 - }, - "total": { - "type": "number", - "example": 1 - } - } - }, - "requests": { - "type": "object", - "properties": { - "failed": { - "type": "number", - "example": 1 - }, - "total": { - "type": "number", - "example": 3 - } - } - } - } - } - } - } - } - }, - "examples": { - "Monitor Run with Errors": { - "value": { - "run": { - "executions": [ - { - "id": 1, - "item": { - "id": "b5e8d7dd-909c-4ba7-aef4-8609bc50b586", - "name": "Sample POST Request" - }, - "request": { - "body": { - "contentLength": 18, - "mode": "raw" - }, - "headers": { - "accept": "*/*", - "accept-encoding": "gzip, deflate", - "content-length": 18, - "content-type": "application/json" - }, - "method": "POST", - "timestamp": "2016-12-04T14:30:26.025Z", - "url": "echo.getpostman.com/post" - }, - "response": { - "body": { - "contentLength": 298 - }, - "code": 200, - "headers": { - "connection": "keep-alive", - "content-encoding": "gzip", - "content-type": "application/json", - "date": "Sun, 04 Dec 2016 14:30:26 GMT", - "transfer-encoding": "chunked" - }, - "responseSize": 298, - "responseTime": 26 - } - }, - { - "assertions": { - "Status code is 400": false - }, - "id": 2, - "item": { - "id": "f790d046-755d-44f5-a416-b825e18dfd9d", - "name": "Sample GET Request" - }, - "request": { - "body": { - "contentLength": 0, - "mode": "formdata" - }, - "headers": { - "accept": "*/*", - "accept-encoding": "gzip, deflate" - }, - "method": "GET", - "timestamp": "2016-12-04T14:30:26.093Z", - "url": "echo.getpostman.com/get" - }, - "response": { - "body": { - "contentLength": 280 - }, - "code": 200, - "headers": { - "connection": "keep-alive", - "content-encoding": "gzip", - "content-type": "application/json", - "date": "Sun, 04 Dec 2016 14:30:26 GMT", - "transfer-encoding": "chunked" - }, - "responseSize": 280, - "responseTime": 46 - } - }, - { - "id": 3, - "item": { - "id": "336e6e17-6d3e-4b8f-a48f-b7e75cf13afb", - "name": "This is the second request" - }, - "request": { - "body": { - "contentLength": 0, - "mode": "formdata" - }, - "headers": { - "accept": "*/*", - "accept-encoding": "gzip, deflate", - "content-length": 18 - }, - "method": "POST", - "timestamp": "2016-12-04T14:30:26.477Z", - "url": "echo.getpostman.com/post" - }, - "response": { - "body": { - "contentLength": 345 - }, - "code": 200, - "headers": { - "connection": "keep-alive", - "content-encoding": "gzip", - "content-type": "application/json", - "date": "Sun, 04 Dec 2016 14:30:26 GMT", - "transfer-encoding": "chunked" - }, - "responseSize": 345, - "responseTime": 9 - } - } - ], - "failures": [ - { - "assertion": { - "Status code is 400": false - }, - "executionId": 2, - "message": "Expected 'Status code is 400' to be truthy", - "name": "AssertionError" - } - ], - "info": { - "collectionUid": "5852-1d3daef4-2037-4584-ab86-bafd8c8f8a55", - "finishedAt": "2016-12-04T14:30:26.000Z", - "jobId": "1e6ba2e3-1aaf-4c10-bd5f-905943284b2a", - "monitorId": "1e6b8970-fd13-4480-b011-b3b3e3cd271d", - "name": "Sample Collection monitor 1 #56", - "startedAt": "2016-12-04T14:30:25.000Z", - "status": "failed" - }, - "stats": { - "assertions": { - "failed": 1, - "total": 1 - }, - "requests": { - "failed": 1, - "total": 3 - } - } - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "monitor_uid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, - "/webhooks": { - "post": { - "tags": [ - "Webhooks" - ], - "summary": "Create Webhook", - "description": "Create a webhook that triggers a collection with your custom payload.\n\nYou can specify the webhook name and the collection to trigger by using the following attributes of the `webhook` object on your JSON body:\n\n* `name`: the name of the webhook that you're creating.\n* `collection`: the ID of the collection that you want to trigger once this webhook is called.\n\nOnce created, the webhook URL can be retrieved by accessing the `webhookUrl` attribute of the `webhook` object on the response JSON payload.", - "operationId": "createWebhook", - "parameters": [ - { - "name": "workspace", - "in": "query", - "schema": { - "type": "string", - "example": "{{workspace_id}}" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "webhook": { - "type": "object", - "properties": { - "collection": { - "type": "string", - "example": "{{collection_id}}" - }, - "name": { - "type": "string", - "example": "{{webhook_name}}" - } - } - } - } - }, - "example": { - "webhook": { - "collection": "{{collection_id}}", - "name": "{{webhook_name}}" - } - } - } - } - }, - "responses": { - "200": { - "description": "" - } - } - } - }, - "/workspaces": { - "get": { - "tags": [ - "Workspaces" - ], - "summary": "All workspaces", - "description": "The `/workspaces` endpoint returns a list of all [workspaces](https://www.getpostman.com/docs/v6/postman/workspaces/intro_to_workspaces) that is accessible by you. The list includes your own workspaces and the workspaces that you have access to.\n\nThe response contains an array of collection information containing the `name`, `id`, and `type` of each workspace.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "allWorkspaces", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspaces": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "4e6d34c2-cfdb-4b33-8868-12a875bebda3" - }, - "name": { - "type": "string", - "example": "My Workspace" - }, - "type": { - "type": "string", - "example": "personal" - } - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "workspaces": [ - { - "id": "4e6d34c2-cfdb-4b33-8868-12a875bebda3", - "name": "My Workspace", - "type": "personal" - }, - { - "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696", - "name": "Team workspace", - "type": "team" - } - ] - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "Workspaces" - ], - "summary": "Create Workspace", - "description": "This endpoint allows you to create a workspace and populate it with entities like `collections`, `environments`, `mocks` and `monitors` using their `uid`.\n\nOn successful creation of the workspace, the response returns the workspcae `name` and `id`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "createWorkspace", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - }, - "name": { - "type": "string", - "example": "Straw hats" - }, - "uid": { - "type": "string", - "example": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - } - } - } - }, - "description": { - "type": "string", - "example": "Some description" - }, - "environments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "83a1aaa2-a204-4bd8-9b92-4d486918906b" - }, - "name": { - "type": "string", - "example": "env" - }, - "uid": { - "type": "string", - "example": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b" - } - } - } - }, - "mocks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "cda672ef-1375-40e9-baee-e20ece8d7b65" - } - } - } - }, - "monitors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec" - } - } - } - }, - "name": { - "type": "string", - "example": "New Workspace" - }, - "type": { - "type": "string", - "example": "personal" - } - } - } - } - }, - "example": { - "workspace": { - "collections": [ - { - "id": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d", - "name": "Straw hats", - "uid": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - } - ], - "description": "Some description", - "environments": [ - { - "id": "83a1aaa2-a204-4bd8-9b92-4d486918906b", - "name": "env", - "uid": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b" - } - ], - "mocks": [ - { - "id": "cda672ef-1375-40e9-baee-e20ece8d7b65" - } - ], - "monitors": [ - { - "id": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec" - } - ], - "name": "New Workspace", - "type": "personal" - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f" - }, - "name": { - "type": "string", - "example": "New Workspace" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "workspace": { - "id": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f", - "name": "New Workspace" - } - } - } - } - } - } - }, - "400": { - "description": "Instance supplied not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Instance not found in the database." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Instance supplied not found": { - "value": { - "error": { - "message": "Instance not found in the database.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - } - }, - "/workspaces/{workspace_id}": { - "get": { - "tags": [ - "Workspaces" - ], - "summary": "Single workspace", - "description": "Access the contents of a workspace that is accessible to you using its id (`id`). Includes the collections, environments, mocks and monitors of that workspace.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "singleWorkspace", - "responses": { - "200": { - "description": "Valid Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "7c31b469-bd43-4411-9283-6d397855ee0e" - }, - "name": { - "type": "string", - "example": "Mock demo - collection" - }, - "uid": { - "type": "string", - "example": "1234-7c31b469-bd43-4411-9283-6d397855ee0e" - } - } - } - }, - "description": { - "type": "string", - "example": "Demos." - }, - "environments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "423fd955-a9c8-47cd-9ab0-09a6a575c4be" - }, - "name": { - "type": "string", - "example": "Mock demo - CNX" - }, - "uid": { - "type": "string", - "example": "1234-423fd955-a9c8-47cd-9ab0-09a6a575c4be" - } - } - } - }, - "id": { - "type": "string", - "example": "f8801e9e-03a4-4c7b-b31e-5db5cd771696" - }, - "name": { - "type": "string", - "example": "Demo workspace" - }, - "type": { - "type": "string", - "example": "personal" - } - } - } - } - }, - "examples": { - "Valid Response": { - "value": { - "workspace": { - "collections": [ - { - "id": "7c31b469-bd43-4411-9283-6d397855ee0e", - "name": "Mock demo - collection", - "uid": "1234-7c31b469-bd43-4411-9283-6d397855ee0e" - }, - { - "id": "356fe068-a0f8-4f31-b34d-d12149eac681", - "name": "Mock demo - response code", - "uid": "1234-356fe068-a0f8-4f31-b34d-d12149eac681" - } - ], - "description": "Demos.", - "environments": [ - { - "id": "423fd955-a9c8-47cd-9ab0-09a6a575c4be", - "name": "Mock demo - CNX", - "uid": "1234-423fd955-a9c8-47cd-9ab0-09a6a575c4be" - }, - { - "id": "24c45c84-5147-4c15-bb9a-c3186b81d3cc", - "name": "Mock Demo - response code", - "uid": "1234-24c45c84-5147-4c15-bb9a-c3186b81d3cc" - } - ], - "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696", - "name": "Demo workspace", - "type": "personal" - } - } - } - } - } - } - }, - "404": { - "description": "Workspace Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Instance not found in the database." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Workspace Not Found": { - "value": { - "error": { - "message": "Instance not found in the database.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Workspaces" - ], - "summary": "Update Workspace", - "description": "This endpoint allows you to update a workspace and update it's association to entities like `collections`, `environments`, `mocks` and `monitors` using their `uid`.\n\nOn successful updation of the workspace, the response returns the workspcae `name` and `id`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.\n\n**Note** : The endpoint expects you to send the desired state of the workspace in terms of the associated entities so be careful when trying to update these entities.\n\nFor eg. if your workspace has collections A and B, and in the update call, you send C's uid in the collections array, then A and B would be removed from the workspace and C would be added.", - "operationId": "updateWorkspace", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "collections": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - }, - "name": { - "type": "string", - "example": "Straw hats" - }, - "uid": { - "type": "string", - "example": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - } - } - } - }, - "description": { - "type": "string", - "example": "Some description" - }, - "environments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "83a1aaa2-a204-4bd8-9b92-4d486918906b" - }, - "name": { - "type": "string", - "example": "env" - }, - "uid": { - "type": "string", - "example": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b" - } - } - } - }, - "mocks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "cda672ef-1375-40e9-baee-e20ece8d7b65" - } - } - } - }, - "monitors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec" - } - } - } - }, - "name": { - "type": "string", - "example": "New Workspace updated" - } - } - } - } - }, - "example": { - "workspace": { - "collections": [ - { - "id": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d", - "name": "Straw hats", - "uid": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d" - } - ], - "description": "Some description", - "environments": [ - { - "id": "83a1aaa2-a204-4bd8-9b92-4d486918906b", - "name": "env", - "uid": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b" - } - ], - "mocks": [ - { - "id": "cda672ef-1375-40e9-baee-e20ece8d7b65" - } - ], - "monitors": [ - { - "id": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec" - } - ], - "name": "New Workspace updated" - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f" - }, - "name": { - "type": "string", - "example": "New Workspace" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "workspace": { - "id": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f", - "name": "New Workspace" - } - } - } - } - } - } - }, - "403": { - "description": "Not enough permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "You do not have access to update this workspace." - }, - "name": { - "type": "string", - "example": "forbiddenError" - } - } - } - } - }, - "examples": { - "Not enough permissions": { - "value": { - "error": { - "message": "You do not have access to update this workspace.", - "name": "forbiddenError" - } - } - } - } - } - } - }, - "404": { - "description": "Specified workspace/entities do not exist", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The specified workspace does not exist." - }, - "name": { - "type": "string", - "example": "instanceNotFoundError" - } - } - } - } - }, - "examples": { - "Specified workspace/entities do not exist": { - "value": { - "error": { - "message": "The specified workspace does not exist.", - "name": "instanceNotFoundError" - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Workspaces" - ], - "summary": "Delete Workspace", - "description": "This endpoint allows you to delete an existing workspace.\n\nOn successful deletion of the workspace, the response returns the `id`.\n\n> Requires API Key as `X-Api-Key` request header or `apikey` URL query parameter.", - "operationId": "deleteWorkspace", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "workspace": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "{{workspace_id}}" - } - } - } - } - }, - "examples": { - "Successful Response": { - "value": { - "workspace": { - "id": "{{workspace_id}}" - } - } - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "workspace_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - } - }, - "tags": [ - { - "name": "Collections" - }, - { - "name": "Environments" - }, - { - "name": "Mocks" - }, - { - "name": "Monitors" - }, - { - "name": "Workspaces" - }, - { - "name": "User" - }, - { - "name": "Import" - }, - { - "name": "API" - }, - { - "name": "API Version", - "description": "This folder contains the requests around API versions." - }, - { - "name": "Schema", - "description": "This folder contains all the endpoints related to Schemas." - }, - { - "name": "Relations", - "description": "This contains requests related to relations. \n\nRelations can be of the following types: \n- `contracttest`\n- `integrationtest`\n- `documentation`\n- `testsuite`\n- `environment`\n- `mock`\n- `monitor`" - }, - { - "name": "Webhooks", - "description": "With webhooks you can trigger a collection at a specific time with your own custom payload which can then be accessed in the collection.\n\nLearn more about webhooks in our [learning center](https://learning.postman.com/docs/designing-and-developing-your-api/monitoring-your-api/integrations-for-alerts/)." - } - ] -} \ No newline at end of file diff --git a/test/blackbox/docs/OpenAPI-3_0/twilio-1_13.json b/test/blackbox/docs/OpenAPI-3_0/twilio-1_13.json deleted file mode 100644 index 4f955ff345..0000000000 --- a/test/blackbox/docs/OpenAPI-3_0/twilio-1_13.json +++ /dev/null @@ -1,30476 +0,0 @@ -{ - "components": { - "schemas": { - "api.v2010.account": { - "properties": { - "auth_token": { - "description": "The authorization token for this account", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The date this account was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date this account was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A human readable description of this account", - "nullable": true, - "type": "string" - }, - "owner_account_sid": { - "description": "The unique 34 character id representing the parent of this account", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "A 34 character string that uniquely identifies this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of this account", - "enum": [ - "active", - "suspended", - "closed" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "Account Instance Subresources", - "nullable": true, - "type": "object" - }, - "type": { - "description": "The type of this account", - "enum": [ - "Trial", - "Full" - ], - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI for this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.address": { - "properties": { - "account_sid": { - "description": "The SID of the Account that is responsible for the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "city": { - "description": "The city in which the address is located", - "nullable": true, - "type": "string" - }, - "customer_name": { - "description": "The name associated with the address", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_enabled": { - "description": "Whether emergency calling has been enabled on this number", - "nullable": true, - "type": "boolean" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of the address", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal code of the address", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The state or region of the address", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "street": { - "description": "The number and street address of the address", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "validated": { - "description": "Whether the address has been validated to comply with local regulation", - "nullable": true, - "type": "boolean" - }, - "verified": { - "description": "Whether the address has been verified to comply with regulation", - "nullable": true, - "type": "boolean" - } - }, - "type": "object" - }, - "api.v2010.account.address.dependent_phone_number": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_requirements": { - "description": "Whether the phone number requires an Address registered with Twilio", - "enum": [ - "none", - "any", - "local", - "foreign" - ], - "nullable": true, - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "capabilities": { - "description": "Indicate if a phone can receive calls or messages", - "nullable": true, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_address_sid": { - "description": "The emergency address configuration to use for emergency calling", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_status": { - "description": "Whether the phone number is enabled for emergency calling", - "enum": [ - "Active", - "Inactive" - ], - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_application_sid": { - "description": "The SID of the application that handles SMS messages sent to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The SID of the Trunk that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_application_sid": { - "description": "The SID of the application that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs in TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when the phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.application": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "message_status_callback": { - "description": "The URL to send message status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when a TwiML error occurs", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when the phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.authorized_connect_app": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "connect_app_company_name": { - "description": "The company name set for the Connect App", - "nullable": true, - "type": "string" - }, - "connect_app_description": { - "description": "A detailed description of the app", - "nullable": true, - "type": "string" - }, - "connect_app_friendly_name": { - "description": "The name of the Connect App", - "nullable": true, - "type": "string" - }, - "connect_app_homepage_url": { - "description": "The public URL for the Connect App", - "format": "uri", - "nullable": true, - "type": "string" - }, - "connect_app_sid": { - "description": "The SID that we assigned to the Connect App", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "permissions": { - "description": "Permissions authorized to the app", - "items": { - "enum": [ - "get-all", - "post-all" - ], - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country": { - "properties": { - "beta": { - "description": "Whether all phone numbers available in the country are new to the Twilio platform.", - "nullable": true, - "type": "boolean" - }, - "country": { - "description": "The name of the country", - "nullable": true, - "type": "string" - }, - "country_code": { - "description": "The ISO-3166-1 country code of the country.", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the Country resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_local": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_mobile": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_national": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_shared_cost": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_toll_free": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.available_phone_number_country.available_phone_number_voip": { - "properties": { - "address_requirements": { - "description": "The type of Address resource the phone number requires", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "capabilities": { - "description": "Whether a phone number can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "friendly_name": { - "description": "A formatted version of the phone number", - "nullable": true, - "type": "string" - }, - "iso_country": { - "description": "The ISO country code of this phone number", - "nullable": true, - "type": "string" - }, - "lata": { - "description": "The LATA of this phone number", - "nullable": true, - "type": "string" - }, - "latitude": { - "description": "The latitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "locality": { - "description": "The locality or city of this phone number's location", - "nullable": true, - "type": "string" - }, - "longitude": { - "description": "The longitude of this phone number's location", - "nullable": true, - "type": "number" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "postal_code": { - "description": "The postal or ZIP code of this phone number's location", - "nullable": true, - "type": "string" - }, - "rate_center": { - "description": "The rate center of this phone number", - "nullable": true, - "type": "string" - }, - "region": { - "description": "The two-letter state or province abbreviation of this phone number's location", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.balance": { - "properties": { - "account_sid": { - "description": "Account Sid.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "balance": { - "description": "Account balance", - "nullable": true, - "type": "string" - }, - "currency": { - "description": "Currency units", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "annotation": { - "description": "The annotation provided for the call", - "nullable": true, - "type": "string" - }, - "answered_by": { - "description": "Either `human` or `machine` if this call was initiated with answering machine detection. Empty otherwise.", - "nullable": true, - "type": "string" - }, - "api_version": { - "description": "The API Version used to create the call", - "nullable": true, - "type": "string" - }, - "caller_name": { - "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "direction": { - "description": "A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The length of the call in seconds.", - "nullable": true, - "type": "string" - }, - "end_time": { - "description": "The end time of the call. Null if the call did not complete successfully.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "forwarded_from": { - "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.", - "nullable": true, - "type": "string" - }, - "from": { - "description": "The phone number, SIP address or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", - "nullable": true, - "type": "string" - }, - "from_formatted": { - "description": "The calling phone number, SIP address, or Client identifier formatted for display.", - "nullable": true, - "type": "string" - }, - "group_sid": { - "description": "The Group SID associated with this call. If no Group is associated with the call, the field is empty.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^GP[0-9a-fA-F]{32}$", - "type": "string" - }, - "parent_call_sid": { - "description": "The SID that identifies the call that created this leg.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "phone_number_sid": { - "description": "If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "price": { - "description": "The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.", - "nullable": true, - "type": "string" - }, - "price_unit": { - "description": "The currency in which `Price` is measured.", - "nullable": true, - "type": "string" - }, - "queue_time": { - "description": "The wait time in milliseconds before the call is placed.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "start_time": { - "description": "The start time of the call. Null if the call has not yet been dialed.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "status": { - "description": "The status of this call.", - "enum": [ - "queued", - "ringing", - "in-progress", - "completed", - "busy", - "failed", - "no-answer", - "canceled" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related subresources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "to": { - "description": "The phone number, SIP address or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", - "nullable": true, - "type": "string" - }, - "to_formatted": { - "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display.", - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The (optional) unique identifier of the trunk resource that was used for this call.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_event": { - "properties": { - "request": { - "description": "Call Request.", - "nullable": true, - "type": "object" - }, - "response": { - "description": "Call Response with Events.", - "nullable": true, - "type": "object" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_feedback": { - "properties": { - "account_sid": { - "description": "The unique sid that identifies this account", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "issues": { - "description": "Issues experienced during the call", - "items": { - "enum": [ - "audio-latency", - "digits-not-captured", - "dropped-call", - "imperfect-audio", - "incorrect-caller-id", - "one-way-audio", - "post-dial-delay", - "unsolicited-call" - ], - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "quality_score": { - "description": "1 to 5 quality score", - "nullable": true, - "type": "integer" - }, - "sid": { - "description": "A string that uniquely identifies this feedback resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_feedback_summary": { - "properties": { - "account_sid": { - "description": "The unique sid that identifies this account", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_count": { - "description": "The total number of calls", - "nullable": true, - "type": "integer" - }, - "call_feedback_count": { - "description": "The total number of calls with a feedback entry", - "nullable": true, - "type": "integer" - }, - "date_created": { - "description": "The date this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The latest feedback entry date in the summary", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "include_subaccounts": { - "description": "Whether the feedback summary includes subaccounts", - "nullable": true, - "type": "boolean" - }, - "issues": { - "description": "Issues experienced during the call", - "items": { - "properties": { - "count": { - "type": "number" - }, - "description": { - "type": "string" - }, - "percentage_of_total_calls": { - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "quality_score_average": { - "description": "The average QualityScore of the feedback entries", - "nullable": true, - "type": "number" - }, - "quality_score_median": { - "description": "The median QualityScore of the feedback entries", - "nullable": true, - "type": "number" - }, - "quality_score_standard_deviation": { - "description": "The standard deviation of the quality scores", - "nullable": true, - "type": "number" - }, - "sid": { - "description": "A string that uniquely identifies this feedback entry", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^FS[0-9a-fA-F]{32}$", - "type": "string" - }, - "start_date": { - "description": "The earliest feedback entry date in the summary", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "status": { - "description": "The status of the feedback summary", - "enum": [ - "queued", - "in-progress", - "completed", - "failed" - ], - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_notification": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the Call Notification resource", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "error_code": { - "description": "A unique error code corresponding to the notification", - "nullable": true, - "type": "string" - }, - "log": { - "description": "An integer log level", - "nullable": true, - "type": "string" - }, - "message_date": { - "description": "The date the notification was generated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "message_text": { - "description": "The text of the notification", - "nullable": true, - "type": "string" - }, - "more_info": { - "description": "A URL for more information about the error code", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_method": { - "description": "HTTP method used with the request url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "request_url": { - "description": "URL of the resource that generated the notification", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_notification-instance": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the Call Notification resource", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "error_code": { - "description": "A unique error code corresponding to the notification", - "nullable": true, - "type": "string" - }, - "log": { - "description": "An integer log level", - "nullable": true, - "type": "string" - }, - "message_date": { - "description": "The date the notification was generated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "message_text": { - "description": "The text of the notification", - "nullable": true, - "type": "string" - }, - "more_info": { - "description": "A URL for more information about the error code", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_method": { - "description": "HTTP method used with the request url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "request_url": { - "description": "URL of the resource that generated the notification", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_variables": { - "description": "Twilio-generated HTTP variables sent to the server", - "nullable": true, - "type": "string" - }, - "response_body": { - "description": "The HTTP body returned by your server", - "nullable": true, - "type": "string" - }, - "response_headers": { - "description": "The HTTP headers returned by your server", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.call_recording": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to make the recording", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "channels": { - "description": "The number of channels in the final recording file", - "nullable": true, - "type": "integer" - }, - "conference_sid": { - "description": "The Conference SID that identifies the conference associated with the recording", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The length of the recording in seconds", - "nullable": true, - "type": "string" - }, - "encryption_details": { - "description": "How to decrypt the recording.", - "nullable": true, - "type": "object" - }, - "error_code": { - "description": "More information about why the recording is missing, if status is `absent`.", - "nullable": true, - "type": "integer" - }, - "price": { - "description": "The one-time cost of creating the recording.", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency used in the price property.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "source": { - "description": "How the recording was created", - "enum": [ - "DialVerb", - "Conference", - "OutboundAPI", - "Trunking", - "RecordVerb", - "StartCallRecordingAPI", - "StartConferenceRecordingAPI" - ], - "nullable": true, - "type": "string" - }, - "start_time": { - "description": "The start time of the recording, given in RFC 2822 format", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "status": { - "description": "The status of the recording", - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "nullable": true, - "type": "string" - }, - "track": { - "description": "The recorded track. Can be: `inbound`, `outbound`, or `both`.", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.call.payments": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the Payments resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The SID of the Payments resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.conference": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create this conference", - "nullable": true, - "type": "string" - }, - "call_sid_ending_conference": { - "description": "The call SID that caused the conference to end", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A string that you assigned to describe this conference room", - "nullable": true, - "type": "string" - }, - "reason_conference_ended": { - "description": "The reason why a conference ended.", - "enum": [ - "conference-ended-via-api", - "participant-with-end-conference-on-exit-left", - "participant-with-end-conference-on-exit-kicked", - "last-participant-kicked", - "last-participant-left" - ], - "nullable": true, - "type": "string" - }, - "region": { - "description": "A string that represents the Twilio Region where the conference was mixed", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of this conference", - "enum": [ - "init", - "in-progress", - "completed" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.conference.conference_recording": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the recording", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "channels": { - "description": "The number of channels in the final recording file as an integer", - "nullable": true, - "type": "integer" - }, - "conference_sid": { - "description": "The Conference SID that identifies the conference associated with the recording", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The length of the recording in seconds", - "nullable": true, - "type": "string" - }, - "encryption_details": { - "description": "How to decrypt the recording.", - "nullable": true, - "type": "object" - }, - "error_code": { - "description": "More information about why the recording is missing, if status is `absent`.", - "nullable": true, - "type": "integer" - }, - "price": { - "description": "The one-time cost of creating the recording.", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency used in the price property.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "source": { - "description": "How the recording was created", - "enum": [ - "DialVerb", - "Conference", - "OutboundAPI", - "Trunking", - "RecordVerb", - "StartCallRecordingAPI", - "StartConferenceRecordingAPI" - ], - "nullable": true, - "type": "string" - }, - "start_time": { - "description": "The start time of the recording, given in RFC 2822 format", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "status": { - "description": "The status of the recording", - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.conference.participant": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid_to_coach": { - "description": "The SID of the participant who is being `coached`", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "coaching": { - "description": "Indicates if the participant changed to coach", - "nullable": true, - "type": "boolean" - }, - "conference_sid": { - "description": "The SID of the conference the participant is in", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "end_conference_on_exit": { - "description": "Whether the conference ends when the participant leaves", - "nullable": true, - "type": "boolean" - }, - "hold": { - "description": "Whether the participant is on hold", - "nullable": true, - "type": "boolean" - }, - "label": { - "description": "The label of this participant", - "nullable": true, - "type": "string" - }, - "muted": { - "description": "Whether the participant is muted", - "nullable": true, - "type": "boolean" - }, - "start_conference_on_enter": { - "description": "Whether the conference starts when the participant joins the conference", - "nullable": true, - "type": "boolean" - }, - "status": { - "description": "The status of the participant's call in a session", - "enum": [ - "queued", - "connecting", - "ringing", - "connected", - "complete", - "failed" - ], - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.connect_app": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "authorize_redirect_url": { - "description": "The URL to redirect the user to after authorization", - "format": "uri", - "nullable": true, - "type": "string" - }, - "company_name": { - "description": "The company name set for the Connect App", - "nullable": true, - "type": "string" - }, - "deauthorize_callback_method": { - "description": "The HTTP method we use to call deauthorize_callback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "deauthorize_callback_url": { - "description": "The URL we call to de-authorize the Connect App", - "format": "uri", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the Connect App", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "homepage_url": { - "description": "The URL users can obtain more information", - "format": "uri", - "nullable": true, - "type": "string" - }, - "permissions": { - "description": "The set of permissions that your ConnectApp requests", - "items": { - "enum": [ - "get-all", - "post-all" - ], - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_requirements": { - "description": "Whether the phone number requires an Address registered with Twilio.", - "enum": [ - "none", - "any", - "local", - "foreign" - ], - "nullable": true, - "type": "string" - }, - "address_sid": { - "description": "The SID of the Address resource associated with the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "bundle_sid": { - "description": "The SID of the Bundle resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "capabilities": { - "description": "Indicate if a phone can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_address_sid": { - "description": "The emergency address configuration to use for emergency calling", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_status": { - "description": "Whether the phone number is enabled for emergency calling", - "enum": [ - "Active", - "Inactive" - ], - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "identity_sid": { - "description": "The SID of the Identity resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "origin": { - "description": "The phone number's origin. Can be twilio or hosted.", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_application_sid": { - "description": "The SID of the application that handles SMS messages sent to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status": { - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The SID of the Trunk that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_application_sid": { - "description": "The SID of the application that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs in TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_receive_mode": { - "enum": [ - "voice", - "fax" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when the phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "configuration": { - "description": "A JSON string that represents the current configuration", - "nullable": true, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A short description of the Add-on functionality", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "resource_sid": { - "description": "The SID of the Phone Number that installed this Add-on", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "unique_name": { - "description": "An application-defined string that uniquely identifies the resource", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "assigned_add_on_sid": { - "description": "The SID that uniquely identifies the assigned Add-on installation", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "enabled": { - "description": "Whether the Extension will be invoked", - "nullable": true, - "type": "boolean" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "product_name": { - "description": "A string that you assigned to describe the Product this Extension is used within", - "nullable": true, - "type": "string" - }, - "resource_sid": { - "description": "The SID of the Phone Number to which the Add-on is assigned", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - }, - "unique_name": { - "description": "An application-defined string that uniquely identifies the resource", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number.incoming_phone_number_local": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_requirements": { - "description": "Whether the phone number requires an Address registered with Twilio.", - "enum": [ - "none", - "any", - "local", - "foreign" - ], - "nullable": true, - "type": "string" - }, - "address_sid": { - "description": "The SID of the Address resource associated with the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "bundle_sid": { - "description": "The SID of the Bundle resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "capabilities": { - "description": "Indicate if a phone can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_address_sid": { - "description": "The emergency address configuration to use for emergency calling", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_status": { - "description": "Whether the phone number is enabled for emergency calling", - "enum": [ - "Active", - "Inactive" - ], - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "identity_sid": { - "description": "The SID of the Identity resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "origin": { - "description": "The phone number's origin. Can be twilio or hosted.", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_application_sid": { - "description": "The SID of the Application resource to handle SMS messages", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status": { - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The SID of the Trunk that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_application_sid": { - "description": "The SID of the application that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs in TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_receive_mode": { - "enum": [ - "voice", - "fax" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when this phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number.incoming_phone_number_mobile": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_requirements": { - "description": "Whether the phone number requires an Address registered with Twilio.", - "enum": [ - "none", - "any", - "local", - "foreign" - ], - "nullable": true, - "type": "string" - }, - "address_sid": { - "description": "The SID of the Address resource associated with the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "bundle_sid": { - "description": "The SID of the Bundle resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "capabilities": { - "description": "Indicate if a phone can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_address_sid": { - "description": "The emergency address configuration to use for emergency calling", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_status": { - "description": "Whether the phone number is enabled for emergency calling", - "enum": [ - "Active", - "Inactive" - ], - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "identity_sid": { - "description": "The SID of the Identity resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "origin": { - "description": "The phone number's origin. Can be twilio or hosted.", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_application_sid": { - "description": "The SID of the application that handles SMS messages sent to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status": { - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The SID of the Trunk that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_application_sid": { - "description": "The SID of the application that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs in TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_receive_mode": { - "enum": [ - "voice", - "fax" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when the phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "address_requirements": { - "description": "Whether the phone number requires an Address registered with Twilio.", - "enum": [ - "none", - "any", - "local", - "foreign" - ], - "nullable": true, - "type": "string" - }, - "address_sid": { - "description": "The SID of the Address resource associated with the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "beta": { - "description": "Whether the phone number is new to the Twilio platform", - "nullable": true, - "type": "boolean" - }, - "bundle_sid": { - "description": "The SID of the Bundle resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "capabilities": { - "description": "Indicate if a phone can receive calls or messages", - "nullable": true, - "properties": { - "fax": { - "type": "boolean" - }, - "mms": { - "type": "boolean" - }, - "sms": { - "type": "boolean" - }, - "voice": { - "type": "boolean" - } - }, - "type": "object" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "emergency_address_sid": { - "description": "The emergency address configuration to use for emergency calling", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_status": { - "description": "Whether the phone number is enabled for emergency calling", - "enum": [ - "Active", - "Inactive" - ], - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "identity_sid": { - "description": "The SID of the Identity resource associated with number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "origin": { - "description": "The phone number's origin. Can be twilio or hosted.", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_application_sid": { - "description": "The SID of the application that handles SMS messages sent to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "The HTTP method used with sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "The HTTP method to use with sms_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "The URL we call when the phone number receives an incoming SMS message", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status": { - "nullable": true, - "type": "string" - }, - "status_callback": { - "description": "The URL to send status information to your application", - "format": "uri", - "nullable": true, - "type": "string" - }, - "status_callback_method": { - "description": "The HTTP method we use to call status_callback", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "trunk_sid": { - "description": "The SID of the Trunk that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_application_sid": { - "description": "The SID of the application that handles calls to the phone number", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "voice_caller_id_lookup": { - "description": "Whether to lookup the caller's name", - "nullable": true, - "type": "boolean" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs in TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method used with the voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_receive_mode": { - "enum": [ - "voice", - "fax" - ], - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when the phone number receives a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.key": { - "properties": { - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.message": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to process the message", - "nullable": true, - "type": "string" - }, - "body": { - "description": "The message text", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_sent": { - "description": "The RFC 2822 date and time in GMT when the message was sent", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "direction": { - "description": "The direction of the message", - "enum": [ - "inbound", - "outbound-api", - "outbound-call", - "outbound-reply" - ], - "nullable": true, - "type": "string" - }, - "error_code": { - "description": "The error code associated with the message", - "nullable": true, - "type": "integer" - }, - "error_message": { - "description": "The description of the error_code", - "nullable": true, - "type": "string" - }, - "from": { - "description": "The phone number that initiated the message", - "nullable": true, - "type": "string" - }, - "messaging_service_sid": { - "description": "The SID of the Messaging Service used with the message.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - }, - "num_media": { - "description": "The number of media files associated with the message", - "nullable": true, - "type": "string" - }, - "num_segments": { - "description": "The number of messages used to deliver the message body", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The amount billed for the message", - "nullable": true, - "type": "string" - }, - "price_unit": { - "description": "The currency in which price is measured", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of the message", - "enum": [ - "queued", - "sending", - "sent", - "failed", - "delivered", - "undelivered", - "receiving", - "received", - "accepted", - "scheduled", - "read", - "partially_delivered" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "to": { - "description": "The phone number that received the message", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.message.media": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "content_type": { - "description": "The default mime-type of the media", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "parent_sid": { - "description": "The SID of the resource that created the media", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.message.message_feedback": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "message_sid": { - "description": "The SID of the Message resource for which the feedback was provided", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - }, - "outcome": { - "description": "Whether the feedback has arrived", - "enum": [ - "confirmed", - "unconfirmed" - ], - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.new_key": { - "properties": { - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "secret": { - "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.new_signing_key": { - "properties": { - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "secret": { - "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.notification": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to generate the notification", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "error_code": { - "description": "A unique error code corresponding to the notification", - "nullable": true, - "type": "string" - }, - "log": { - "description": "An integer log level", - "nullable": true, - "type": "string" - }, - "message_date": { - "description": "The date the notification was generated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "message_text": { - "description": "The text of the notification", - "nullable": true, - "type": "string" - }, - "more_info": { - "description": "A URL for more information about the error code", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_method": { - "description": "HTTP method used with the request url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "request_url": { - "description": "URL of the resource that generated the notification", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.notification-instance": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to generate the notification", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "error_code": { - "description": "A unique error code corresponding to the notification", - "nullable": true, - "type": "string" - }, - "log": { - "description": "An integer log level", - "nullable": true, - "type": "string" - }, - "message_date": { - "description": "The date the notification was generated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "message_text": { - "description": "The text of the notification", - "nullable": true, - "type": "string" - }, - "more_info": { - "description": "A URL for more information about the error code", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_method": { - "description": "HTTP method used with the request url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "request_url": { - "description": "URL of the resource that generated the notification", - "format": "uri", - "nullable": true, - "type": "string" - }, - "request_variables": { - "description": "Twilio-generated HTTP variables sent to the server", - "nullable": true, - "type": "string" - }, - "response_body": { - "description": "The HTTP body returned by your server", - "nullable": true, - "type": "string" - }, - "response_headers": { - "description": "The HTTP headers returned by your server", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.outgoing_caller_id": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number in E.164 format", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.queue": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "average_wait_time": { - "description": "Average wait time of members in the queue", - "nullable": true, - "type": "integer" - }, - "current_size": { - "description": "The number of calls currently in the queue.", - "nullable": true, - "type": "integer" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A string that you assigned to describe this resource", - "nullable": true, - "type": "string" - }, - "max_size": { - "description": "The max number of calls allowed in the queue", - "nullable": true, - "type": "integer" - }, - "sid": { - "description": "The unique string that identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.queue.member": { - "properties": { - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_enqueued": { - "description": "The date the member was enqueued", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "position": { - "description": "This member's current position in the queue.", - "nullable": true, - "type": "integer" - }, - "queue_sid": { - "description": "The SID of the Queue the member is in", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "wait_time": { - "description": "The number of seconds the member has been in the queue.", - "nullable": true, - "type": "integer" - } - }, - "type": "object" - }, - "api.v2010.account.recording": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used during the recording.", - "nullable": true, - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "channels": { - "description": "The number of channels in the final recording file as an integer.", - "nullable": true, - "type": "integer" - }, - "conference_sid": { - "description": "The unique ID for the conference associated with the recording.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The length of the recording in seconds.", - "nullable": true, - "type": "string" - }, - "encryption_details": { - "description": "How to decrypt the recording.", - "nullable": true, - "type": "object" - }, - "error_code": { - "description": "More information about why the recording is missing, if status is `absent`.", - "nullable": true, - "type": "integer" - }, - "price": { - "description": "The one-time cost of creating the recording.", - "nullable": true, - "type": "string" - }, - "price_unit": { - "description": "The currency used in the price property.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "source": { - "description": "How the recording was created", - "enum": [ - "DialVerb", - "Conference", - "OutboundAPI", - "Trunking", - "RecordVerb", - "StartCallRecordingAPI", - "StartConferenceRecordingAPI" - ], - "nullable": true, - "type": "string" - }, - "start_time": { - "description": "The start time of the recording, given in RFC 2822 format", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "status": { - "description": "The status of the recording.", - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.recording.recording_add_on_result": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "add_on_configuration_sid": { - "description": "The SID of the Add-on configuration", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "add_on_sid": { - "description": "The SID of the Add-on to which the result belongs", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_completed": { - "description": "The date and time in GMT that the result was completed", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "reference_sid": { - "description": "The SID of the recording to which the AddOnResult resource belongs", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of the result", - "enum": [ - "canceled", - "completed", - "deleted", - "failed", - "in-progress", - "init", - "processing", - "queued" - ], - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - } - }, - "type": "object" - }, - "api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "add_on_configuration_sid": { - "description": "The SID of the Add-on configuration", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - }, - "add_on_result_sid": { - "description": "The SID of the AddOnResult to which the payload belongs", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - }, - "add_on_sid": { - "description": "The SID of the Add-on to which the result belongs", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - }, - "content_type": { - "description": "The MIME type of the payload", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "label": { - "description": "The string that describes the payload", - "nullable": true, - "type": "string" - }, - "reference_sid": { - "description": "The SID of the recording to which the AddOnResult resource that contains the payload belongs", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^XH[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - } - }, - "type": "object" - }, - "api.v2010.account.recording.recording_transcription": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the transcription", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The duration of the transcribed audio in seconds.", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The charge for the transcription", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which price is measured", - "nullable": true, - "type": "string" - }, - "recording_sid": { - "description": "The SID that identifies the transcription's recording", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of the transcription", - "enum": [ - "in-progress", - "completed", - "failed" - ], - "nullable": true, - "type": "string" - }, - "transcription_text": { - "description": "The text content of the transcription.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "The transcription type", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.short_code": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to start a new TwiML session", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A string that you assigned to describe this resource", - "nullable": true, - "type": "string" - }, - "short_code": { - "description": "The short code. e.g., 894546.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SC[0-9a-fA-F]{32}$", - "type": "string" - }, - "sms_fallback_method": { - "description": "HTTP method we use to call the sms_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_fallback_url": { - "description": "URL Twilio will request if an error occurs in executing TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "sms_method": { - "description": "HTTP method to use when requesting the sms url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "sms_url": { - "description": "URL we call when receiving an incoming SMS message to this short code", - "format": "uri", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of this resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.signing_key": { - "properties": { - "date_created": { - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "nullable": true, - "type": "string" - }, - "sid": { - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip": { - "properties": {}, - "type": "object" - }, - "api.v2010.account.sip.sip_credential_list": { - "properties": { - "account_sid": { - "description": "The unique sid that identifies this account", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "Human readable descriptive text", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A string that uniquely identifies this credential", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "The list of credentials associated with this credential list.", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI for this resource", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_credential_list.sip_credential": { - "properties": { - "account_sid": { - "description": "The unique id of the Account that is responsible for this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "credential_list_sid": { - "description": "The unique id that identifies the credential list that includes this credential", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date that this resource was created, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date that this resource was last updated, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A 34 character string that uniquely identifies this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI for this resource, relative to https://api.twilio.com", - "format": "uri", - "nullable": true, - "type": "string" - }, - "username": { - "description": "The username for this credential.", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to process the call", - "nullable": true, - "type": "string" - }, - "auth_type": { - "description": "The types of authentication mapped to the domain", - "nullable": true, - "type": "string" - }, - "byoc_trunk_sid": { - "description": "The SID of the BYOC Trunk resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "domain_name": { - "description": "The unique address on Twilio to route SIP traffic", - "nullable": true, - "type": "string" - }, - "emergency_caller_sid": { - "description": "Whether an emergency caller sid is configured for the domain.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "emergency_calling_enabled": { - "description": "Whether emergency calling is enabled for the domain.", - "nullable": true, - "type": "boolean" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "secure": { - "description": "Whether secure SIP is enabled for the domain", - "nullable": true, - "type": "boolean" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - }, - "sip_registration": { - "description": "Whether SIP registration is allowed", - "nullable": true, - "type": "boolean" - }, - "subresource_uris": { - "description": "A list mapping resources associated with the SIP Domain resource", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_fallback_method": { - "description": "The HTTP method used with voice_fallback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_fallback_url": { - "description": "The URL we call when an error occurs while executing TwiML", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_method": { - "description": "The HTTP method to use with voice_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_status_callback_method": { - "description": "The HTTP method we use to call voice_status_callback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "voice_status_callback_url": { - "description": "The URL that we call with status updates", - "format": "uri", - "nullable": true, - "type": "string" - }, - "voice_url": { - "description": "The URL we call when receiving a call", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth": { - "properties": {}, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls": { - "properties": {}, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations": { - "properties": {}, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_credential_list_mapping": { - "properties": { - "account_sid": { - "description": "The unique id of the Account that is responsible for this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date that this resource was created, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date that this resource was last updated, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A 34 character string that uniquely identifies this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "The credentials associated with this resource.", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI for this resource, relative to https://api.twilio.com", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping": { - "properties": { - "account_sid": { - "description": "The unique id of the Account that is responsible for this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date that this resource was created, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date that this resource was last updated, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A 34 character string that uniquely identifies this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "The list of IP addresses associated with this domain.", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI for this resource, relative to https://api.twilio.com", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_ip_access_control_list": { - "properties": { - "account_sid": { - "description": "The unique sid that identifies this account", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The date this resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date this resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A human readable description of this resource", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A string that uniquely identifies this resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - }, - "subresource_uris": { - "description": "The IP addresses associated with this resource.", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI for this resource", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address": { - "properties": { - "account_sid": { - "description": "The unique id of the Account that is responsible for this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "cidr_prefix_length": { - "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", - "nullable": true, - "type": "integer" - }, - "date_created": { - "description": "The date that this resource was created, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The date that this resource was last updated, given as GMT in RFC 2822 format.", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "nullable": true, - "type": "string" - }, - "ip_access_control_list_sid": { - "description": "The unique id of the IpAccessControlList resource that includes this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - }, - "ip_address": { - "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", - "nullable": true, - "type": "string" - }, - "sid": { - "description": "A 34 character string that uniquely identifies this resource.", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^IP[0-9a-fA-F]{32}$", - "type": "string" - }, - "uri": { - "description": "The URI for this resource, relative to https://api.twilio.com", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.token": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "ice_servers": { - "description": "An array representing the ephemeral credentials", - "items": { - "properties": { - "credential": { - "type": "string" - }, - "url": { - "type": "string" - }, - "urls": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "password": { - "description": "The temporary password used for authenticating", - "nullable": true, - "type": "string" - }, - "ttl": { - "description": "The duration in seconds the credentials are valid", - "nullable": true, - "type": "string" - }, - "username": { - "description": "The temporary username that uniquely identifies a Token", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.transcription": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the transcription", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "duration": { - "description": "The duration of the transcribed audio in seconds.", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The charge for the transcription", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which price is measured", - "nullable": true, - "type": "string" - }, - "recording_sid": { - "description": "The SID that identifies the transcription's recording", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - }, - "status": { - "description": "The status of the transcription", - "enum": [ - "in-progress", - "completed", - "failed" - ], - "nullable": true, - "type": "string" - }, - "transcription_text": { - "description": "The text content of the transcription.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "The transcription type", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage": { - "properties": {}, - "type": "object" - }, - "api.v2010.account.usage.usage_record": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_all_time": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_daily": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_last_month": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_monthly": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_this_month": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_today": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_yearly": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_record.usage_record_yesterday": { - "properties": { - "account_sid": { - "description": "The SID of the Account accrued the usage", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "as_of": { - "description": "Usage records up to date as of this timestamp", - "nullable": true, - "type": "string" - }, - "category": { - "description": "The category of usage", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "count": { - "description": "The number of usage events", - "nullable": true, - "type": "string" - }, - "count_unit": { - "description": "The units in which count is measured", - "nullable": true, - "type": "string" - }, - "description": { - "description": "A plain-language description of the usage category", - "nullable": true, - "type": "string" - }, - "end_date": { - "description": "The last date for which usage is included in the UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "price": { - "description": "The total price of the usage", - "nullable": true, - "type": "number" - }, - "price_unit": { - "description": "The currency in which `price` is measured", - "nullable": true, - "type": "string" - }, - "start_date": { - "description": "The first date for which usage is included in this UsageRecord", - "format": "date", - "nullable": true, - "type": "string" - }, - "subresource_uris": { - "description": "A list of related resources identified by their relative URIs", - "nullable": true, - "type": "object" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage": { - "description": "The amount of usage", - "nullable": true, - "type": "string" - }, - "usage_unit": { - "description": "The units in which usage is measured", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.usage.usage_trigger": { - "properties": { - "account_sid": { - "description": "The SID of the Account that this trigger monitors", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "api_version": { - "description": "The API version used to create the resource", - "nullable": true, - "type": "string" - }, - "callback_method": { - "description": "The HTTP method we use to call callback_url", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true, - "type": "string" - }, - "callback_url": { - "description": "he URL we call when the trigger fires", - "format": "uri", - "nullable": true, - "type": "string" - }, - "current_value": { - "description": "The current value of the field the trigger is watching", - "nullable": true, - "type": "string" - }, - "date_created": { - "description": "The RFC 2822 date and time in GMT that the resource was created", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_fired": { - "description": "The RFC 2822 date and time in GMT that the trigger was last fired", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "date_updated": { - "description": "The RFC 2822 date and time in GMT that the resource was last updated", - "format": "date-time-rfc-2822", - "nullable": true, - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the trigger", - "nullable": true, - "type": "string" - }, - "recurring": { - "description": "The frequency of a recurring UsageTrigger", - "enum": [ - "daily", - "monthly", - "yearly", - "alltime" - ], - "nullable": true, - "type": "string" - }, - "sid": { - "description": "The unique string that identifies the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^UT[0-9a-fA-F]{32}$", - "type": "string" - }, - "trigger_by": { - "description": "The field in the UsageRecord resource that fires the trigger", - "enum": [ - "count", - "usage", - "price" - ], - "nullable": true, - "type": "string" - }, - "trigger_value": { - "description": "The value at which the trigger will fire", - "nullable": true, - "type": "string" - }, - "uri": { - "description": "The URI of the resource, relative to `https://api.twilio.com`", - "format": "uri", - "nullable": true, - "type": "string" - }, - "usage_category": { - "description": "The usage category the trigger watches", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "nullable": true, - "type": "string" - }, - "usage_record_uri": { - "description": "The URI of the UsageRecord resource this trigger watches", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "api.v2010.account.validation_request": { - "properties": { - "account_sid": { - "description": "The SID of the Account that created the resource", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "call_sid": { - "description": "The SID of the Call the resource is associated with", - "maxLength": 34, - "minLength": 34, - "nullable": true, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "friendly_name": { - "description": "The string that you assigned to describe the resource", - "nullable": true, - "type": "string" - }, - "phone_number": { - "description": "The phone number to verify in E.164 format", - "nullable": true, - "type": "string" - }, - "validation_code": { - "description": "The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called", - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - }, - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - } - }, - "info": { - "contact": { - "email": "support@twilio.com", - "name": "Twilio Support", - "url": "https://support.twilio.com" - }, - "description": "This is the public Twilio REST API.", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "termsOfService": "https://www.twilio.com/legal/tos", - "title": "Twilio - Api", - "version": "1.13.0" - }, - "openapi": "3.0.1", - "paths": { - "/2010-04-01/Accounts.json": { - "description": "Twilio accounts (aka Project) or subaccounts", - "get": { - "description": "Retrieves a collection of Accounts belonging to the account used to make the request", - "operationId": "ListAccount", - "parameters": [ - { - "description": "Only return the Account resources with friendly names that exactly match this name.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "Only return Account resources with the given status. Can be `closed`, `suspended` or `active`.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "active", - "suspended", - "closed" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "accounts": { - "items": { - "$ref": "#/components/schemas/api.v2010.account" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAccountResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new Twilio Subaccount from the account making the request", - "operationId": "CreateAccount", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`", - "type": "string" - } - }, - "title": "CreateAccountRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Addresses.json": { - "description": "An Address instance resource represents your or your customer’s physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number.", - "get": { - "description": "", - "operationId": "ListAddress", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `customer_name` of the Address resources to read.", - "in": "query", - "name": "CustomerName", - "schema": { - "type": "string" - } - }, - { - "description": "The string that identifies the Address resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The ISO country code of the Address resources to read.", - "in": "query", - "name": "IsoCountry", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "addresses": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.address" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAddressResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateAddress", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Address resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AutoCorrectAddress": { - "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", - "type": "boolean" - }, - "City": { - "description": "The city of the new address.", - "type": "string" - }, - "CustomerName": { - "description": "The name to associate with the new address.", - "type": "string" - }, - "EmergencyEnabled": { - "description": "Whether to enable emergency calling on the new address. Can be: `true` or `false`.", - "type": "boolean" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new address. It can be up to 64 characters long.", - "type": "string" - }, - "IsoCountry": { - "description": "The ISO country code of the new address.", - "type": "string" - }, - "PostalCode": { - "description": "The postal code of the new address.", - "type": "string" - }, - "Region": { - "description": "The state or region of the new address.", - "type": "string" - }, - "Street": { - "description": "The number and street address of the new address.", - "type": "string" - } - }, - "required": [ - "CustomerName", - "Street", - "City", - "Region", - "PostalCode", - "IsoCountry" - ], - "title": "CreateAddressRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.address" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "validated", - "verified" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json": { - "description": "Phone numbers dependent on an Address resource", - "get": { - "description": "", - "operationId": "ListDependentPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Address resource associated with the phone number.", - "in": "path", - "name": "AddressSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "dependent_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListDependentPhoneNumberResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json": { - "delete": { - "description": "", - "operationId": "DeleteAddress", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Address resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "An Address instance resource represents your or your customer’s physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number.", - "get": { - "description": "", - "operationId": "FetchAddress", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Address resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.address" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "UpdateAddress", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Address resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AutoCorrectAddress": { - "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", - "type": "boolean" - }, - "City": { - "description": "The city of the address.", - "type": "string" - }, - "CustomerName": { - "description": "The name to associate with the address.", - "type": "string" - }, - "EmergencyEnabled": { - "description": "Whether to enable emergency calling on the address. Can be: `true` or `false`.", - "type": "boolean" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the address. It can be up to 64 characters long.", - "type": "string" - }, - "PostalCode": { - "description": "The postal code of the address.", - "type": "string" - }, - "Region": { - "description": "The state or region of the address.", - "type": "string" - }, - "Street": { - "description": "The number and street address of the address.", - "type": "string" - } - }, - "title": "UpdateAddressRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.address" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "validated", - "verified" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Applications.json": { - "description": "An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message.", - "get": { - "description": "Retrieve a list of applications representing an application within the requesting account", - "operationId": "ListApplication", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The string that identifies the Application resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "applications": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.application" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListApplicationResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new application within your account", - "operationId": "CreateApplication", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiVersion": { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default API version.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new application. It can be up to 64 characters long.", - "type": "string" - }, - "MessageStatusCallback": { - "description": "The URL we should call using a POST method to send message status information to your application.", - "format": "uri", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsStatusCallback": { - "description": "The URL we should call using a POST method to send status information about SMS messages sent by the application.", - "format": "uri", - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL we should call when the phone number assigned to this application receives a call.", - "format": "uri", - "type": "string" - } - }, - "title": "CreateApplicationRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.application" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { - "delete": { - "description": "Delete the application by the specified application sid", - "operationId": "DeleteApplication", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Application resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message.", - "get": { - "description": "Fetch the application specified by the provided sid", - "operationId": "FetchApplication", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Application resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.application" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Updates the application's properties", - "operationId": "UpdateApplication", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Application resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiVersion": { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account's default API version.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "MessageStatusCallback": { - "description": "The URL we should call using a POST method to send message status information to your application.", - "format": "uri", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsStatusCallback": { - "description": "Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.", - "format": "uri", - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL we should call when the phone number assigned to this application receives a call.", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateApplicationRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.application" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { - "description": "Authorized Twilio Connect apps", - "get": { - "description": "Retrieve a list of authorized-connect-apps belonging to the account used to make the request", - "operationId": "ListAuthorizedConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "authorized_connect_apps": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAuthorizedConnectAppResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "connect_app_sid", - "connect_app_friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json": { - "description": "Authorized Twilio Connect apps", - "get": { - "description": "Fetch an instance of an authorized-connect-app", - "operationId": "FetchAuthorizedConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Connect App to fetch.", - "in": "path", - "name": "ConnectAppSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "connect_app_sid", - "connect_app_friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { - "description": "Country codes with available phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberCountry", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "countries": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberCountryResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "country_code", - "country", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { - "description": "Country codes with available phone numbers", - "get": { - "description": "", - "operationId": "FetchAvailablePhoneNumberCountry", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country to fetch available phone number information about.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "country_code", - "country", - "beta" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { - "description": "Available local phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberLocal", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberLocalResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json": { - "description": "Available machine-to-machine phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberMachineToMachine", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberMachineToMachineResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json": { - "description": "Available mobile phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberMobile", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberMobileResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json": { - "description": "Available national phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberNational", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberNationalResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json": { - "description": "Available shared cost numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberSharedCost", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberSharedCostResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json": { - "description": "Available toll free phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberTollFree", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberTollFreeResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json": { - "description": "Available VoIP phone numbers", - "get": { - "description": "", - "operationId": "ListAvailablePhoneNumberVoip", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "schema": { - "type": "integer" - } - }, - { - "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", - "in": "query", - "name": "Contains", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", - "in": "query", - "name": "SmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", - "in": "query", - "name": "MmsEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", - "in": "query", - "name": "VoiceEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeAllAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeLocalAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "ExcludeForeignAddressRequired", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "NearLatLong", - "schema": { - "type": "string" - } - }, - { - "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "Distance", - "schema": { - "type": "integer" - } - }, - { - "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InPostalCode", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRegion", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InRateCenter", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "InLata", - "schema": { - "type": "string" - } - }, - { - "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", - "in": "query", - "name": "InLocality", - "schema": { - "type": "string" - } - }, - { - "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", - "in": "query", - "name": "FaxEnabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "available_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListAvailablePhoneNumberVoipResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "phone_number", - "region", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Balance.json": { - "description": "Account balance", - "get": { - "description": "Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information", - "operationId": "FetchBalance", - "parameters": [ - { - "description": "The unique SID identifier of the Account.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.balance" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "balance", - "currency" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls.json": { - "description": "A Call is an object that represents a connection between a telephone and Twilio.", - "get": { - "description": "Retrieves a collection of calls made to and from your account", - "operationId": "ListCall", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only show calls made to this phone number, SIP address, Client identifier or SIM SID.", - "in": "query", - "name": "To", - "schema": { - "type": "string" - } - }, - { - "description": "Only include calls from this phone number, SIP address, Client identifier or SIM SID.", - "in": "query", - "name": "From", - "schema": { - "type": "string" - } - }, - { - "description": "Only include calls spawned by calls with this SID.", - "in": "query", - "name": "ParentCallSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "queued", - "ringing", - "in-progress", - "completed", - "busy", - "failed", - "no-answer", - "canceled" - ], - "type": "string" - } - }, - { - "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", - "in": "query", - "name": "StartTime", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", - "in": "query", - "name": "StartTime<", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", - "in": "query", - "name": "StartTime>", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", - "in": "query", - "name": "EndTime", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", - "in": "query", - "name": "EndTime<", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", - "in": "query", - "name": "EndTime>", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "calls": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.call" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListCallResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections", - "operationId": "CreateCall", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApplicationSid": { - "description": "The SID of the Application resource that will handle the call, if the call will be handled by an application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "AsyncAmd": { - "description": "Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`.", - "type": "string" - }, - "AsyncAmdStatusCallback": { - "description": "The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax.", - "format": "uri", - "type": "string" - }, - "AsyncAmdStatusCallbackMethod": { - "description": "The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Byoc": { - "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - }, - "CallReason": { - "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)", - "type": "string" - }, - "CallToken": { - "description": "A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. this field should be populated by the incoming call's call_token to make this outgoing call as a forwarded call of incoming call. A forwarded call should bear the same caller-id of incoming call.", - "type": "string" - }, - "CallerId": { - "description": "The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.", - "type": "string" - }, - "FallbackMethod": { - "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "FallbackUrl": { - "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", - "format": "uri", - "type": "string" - }, - "From": { - "description": "The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number.", - "type": "string" - }, - "MachineDetection": { - "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).", - "type": "string" - }, - "MachineDetectionSilenceTimeout": { - "description": "The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.", - "type": "integer" - }, - "MachineDetectionSpeechEndThreshold": { - "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.", - "type": "integer" - }, - "MachineDetectionSpeechThreshold": { - "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.", - "type": "integer" - }, - "MachineDetectionTimeout": { - "description": "The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.", - "type": "integer" - }, - "Method": { - "description": "The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Record": { - "description": "Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL.", - "type": "boolean" - }, - "RecordingChannels": { - "description": "The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.", - "type": "string" - }, - "RecordingStatusCallback": { - "description": "The URL that we call when the recording is available to be accessed.", - "type": "string" - }, - "RecordingStatusCallbackEvent": { - "description": "The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space.", - "items": { - "type": "string" - }, - "type": "array" - }, - "RecordingStatusCallbackMethod": { - "description": "The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "RecordingTrack": { - "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.", - "type": "string" - }, - "SendDigits": { - "description": "A string of keys to dial after connecting to the number, maximum of 32 digits. Valid digits in the string include: any digit (`0`-`9`), '`#`', '`*`' and '`w`', to insert a half second pause. For example, if you connected to a company phone number and wanted to pause for one second, and then dial extension 1234 followed by the pound key, the value of this parameter would be `ww1234#`. Remember to URL-encode this string, since the '`#`' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored.", - "type": "string" - }, - "SipAuthPassword": { - "description": "The password required to authenticate the user account specified in `sip_auth_username`.", - "type": "string" - }, - "SipAuthUsername": { - "description": "The username used to authenticate the caller making a SIP call.", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", - "format": "uri", - "type": "string" - }, - "StatusCallbackEvent": { - "description": "The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored.", - "items": { - "type": "string" - }, - "type": "array" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Timeout": { - "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.", - "type": "integer" - }, - "To": { - "description": "The phone number, SIP address, or client identifier to call.", - "type": "string" - }, - "Trim": { - "description": "Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.", - "type": "string" - }, - "Twiml": { - "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored.", - "type": "string" - }, - "Url": { - "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", - "format": "uri", - "type": "string" - } - }, - "required": [ - "To", - "From" - ], - "title": "CreateCallRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "status", - "start_time" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json": { - "description": "Call FeedbackSummary resources provide an idea of how your end user’s perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", - "post": { - "description": "Create a FeedbackSummary resource for a call", - "operationId": "CreateCallFeedbackSummary", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "EndDate": { - "description": "Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC.", - "format": "date", - "type": "string" - }, - "IncludeSubaccounts": { - "description": "Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account.", - "type": "boolean" - }, - "StartDate": { - "description": "Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC.", - "format": "date", - "type": "string" - }, - "StatusCallback": { - "description": "The URL that we will request when the feedback summary is complete.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - "required": [ - "StartDate", - "EndDate" - ], - "title": "CreateCallFeedbackSummaryRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_feedback_count", - "quality_score_average", - "start_date" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json": { - "delete": { - "description": "Delete a FeedbackSummary resource from a call", - "operationId": "DeleteCallFeedbackSummary", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Call FeedbackSummary resources provide an idea of how your end user’s perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", - "get": { - "description": "Fetch a FeedbackSummary resource from a call", - "operationId": "FetchCallFeedbackSummary", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_feedback_count", - "quality_score_average", - "start_date" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of all events for a call.", - "operationId": "ListCallEvent", - "parameters": [ - { - "description": "The unique SID identifier of the Account.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Call.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "events": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_event" - }, - "type": "array" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListCallEventResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "request", - "response" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json": { - "description": "The call Feedback subresource describes the quality experienced during a phone call.", - "get": { - "description": "Fetch a Feedback resource from a call", - "operationId": "FetchCallFeedback", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The call sid that uniquely identifies the call", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update a Feedback resource for a call", - "operationId": "UpdateCallFeedback", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The call sid that uniquely identifies the call", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Issue": { - "description": "One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.", - "items": { - "enum": [ - "audio-latency", - "digits-not-captured", - "dropped-call", - "imperfect-audio", - "incorrect-caller-id", - "one-way-audio", - "post-dial-delay", - "unsolicited-call" - ], - "type": "string" - }, - "type": "array" - }, - "QualityScore": { - "description": "The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call.", - "type": "integer" - } - }, - "required": [ - "QualityScore" - ], - "title": "UpdateCallFeedbackRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "quality_score", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json": { - "description": "Error notifications for calls", - "get": { - "description": "", - "operationId": "ListCallNotification", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", - "in": "query", - "name": "Log", - "schema": { - "type": "integer" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "notifications": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_notification" - }, - "type": "array" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListCallNotificationResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json": { - "description": "Error notifications for calls", - "get": { - "description": "", - "operationId": "FetchCallNotification", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Call Notification resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_notification-instance" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json": { - "description": "Twilio enabled secure payments solution for accepting credit and ACH payments over the phone.", - "post": { - "description": "create an instance of payments. This will start a new payments session", - "operationId": "CreatePayments", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "BankAccountType": { - "description": "Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`.", - "enum": [ - "consumer-checking", - "consumer-savings", - "commercial-checking" - ], - "type": "string" - }, - "ChargeAmount": { - "description": "A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize.", - "type": "number" - }, - "Currency": { - "description": "The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Connector are accepted.", - "type": "string" - }, - "Description": { - "description": "The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.", - "type": "string" - }, - "IdempotencyKey": { - "description": "A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.", - "type": "string" - }, - "Input": { - "description": "A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs.", - "type": "string" - }, - "MinPostalCodeLength": { - "description": "A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits.", - "type": "integer" - }, - "Parameter": { - "description": "A single level JSON string that is required when accepting certain information specific only to ACH payments. The information that has to be included here depends on the Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors).", - "type": "object" - }, - "PaymentConnector": { - "description": "This is the unique name corresponding to the Payment Gateway Connector installed in the Twilio Add-ons. Learn more about [ Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`.", - "type": "string" - }, - "PaymentMethod": { - "description": "Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`.", - "enum": [ - "credit-card", - "ach-debit" - ], - "type": "string" - }, - "PostalCode": { - "description": "Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`.", - "type": "boolean" - }, - "SecurityCode": { - "description": "Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`.", - "type": "boolean" - }, - "StatusCallback": { - "description": "Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)", - "format": "uri", - "type": "string" - }, - "Timeout": { - "description": "The number of seconds that should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`.", - "type": "integer" - }, - "TokenType": { - "description": "Indicates whether the payment method should be tokenized as a `one-time` or `reusable` token. The default value is `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized.", - "enum": [ - "one-time", - "reusable" - ], - "type": "string" - }, - "ValidCardTypes": { - "description": "Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`", - "type": "string" - } - }, - "required": [ - "IdempotencyKey", - "StatusCallback" - ], - "title": "CreatePaymentsRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.payments" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json": { - "description": "Twilio enabled secure payments solution for accepting credit and ACH payments over the phone.", - "post": { - "description": "update an instance of payments with different phases of payment flows.", - "operationId": "UpdatePayments", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will update the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of Payments session that needs to be updated.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Capture": { - "description": "The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, or `bank-account-number`.", - "enum": [ - "payment-card-number", - "expiration-date", - "security-code", - "postal-code", - "bank-routing-number", - "bank-account-number" - ], - "type": "string" - }, - "IdempotencyKey": { - "description": "A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.", - "type": "string" - }, - "Status": { - "description": "Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected connector for processing.", - "enum": [ - "complete", - "cancel" - ], - "type": "string" - }, - "StatusCallback": { - "description": "Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "IdempotencyKey", - "StatusCallback" - ], - "title": "UpdatePaymentsRequest", - "type": "object" - } - } - } - }, - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.payments" - } - } - }, - "description": "Accepted" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json": { - "description": "A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.", - "get": { - "description": "Retrieve a list of recordings belonging to the call used to make the request", - "operationId": "ListCallRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "recordings": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListCallRecordingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a recording for the call", - "operationId": "CreateCallRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) to associate the resource with.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "RecordingChannels": { - "description": "The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels.", - "type": "string" - }, - "RecordingStatusCallback": { - "description": "The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).", - "format": "uri", - "type": "string" - }, - "RecordingStatusCallbackEvent": { - "description": "The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space.", - "items": { - "type": "string" - }, - "type": "array" - }, - "RecordingStatusCallbackMethod": { - "description": "The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "RecordingTrack": { - "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.", - "type": "string" - }, - "Trim": { - "description": "Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not.", - "type": "string" - } - }, - "title": "CreateCallRecordingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json": { - "delete": { - "description": "Delete a recording from your account", - "operationId": "DeleteCallRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.", - "get": { - "description": "Fetch an instance of a recording for a call", - "operationId": "FetchCallRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording.", - "operationId": "UpdateCallRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to update.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "PauseBehavior": { - "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", - "type": "string" - }, - "Status": { - "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "title": "UpdateCallRecordingRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json": { - "delete": { - "description": "Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs.", - "operationId": "DeleteCall", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided Call SID that uniquely identifies the Call resource to delete", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "A Call is an object that represents a connection between a telephone and Twilio.", - "get": { - "description": "Fetch the call specified by the provided Call SID", - "operationId": "FetchCall", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Call resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Initiates a call redirect or terminates a call", - "operationId": "UpdateCall", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Call resource to update", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FallbackMethod": { - "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "FallbackUrl": { - "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", - "format": "uri", - "type": "string" - }, - "Method": { - "description": "The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Status": { - "description": "The new status of the resource. Can be: `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing; however, it will not affect calls already in progress. Specifying `completed` will attempt to hang up a call even if it's already in progress.", - "enum": [ - "canceled", - "completed" - ], - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Twiml": { - "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive", - "type": "string" - }, - "Url": { - "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateCallRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "status", - "start_time" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences.json": { - "description": "Voice call conferences", - "get": { - "description": "Retrieve a list of conferences belonging to the account used to make the request", - "operationId": "ListConference", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateCreated", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateCreated<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateCreated>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateUpdated", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateUpdated<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", - "in": "query", - "name": "DateUpdated>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The string that identifies the Conference resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.", - "in": "query", - "name": "Status", - "schema": { - "enum": [ - "init", - "in-progress", - "completed" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "conferences": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListConferenceResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json": { - "description": "Conference participants", - "get": { - "description": "Retrieve a list of participants belonging to the account used to make the request", - "operationId": "ListParticipant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the conference with the participants to read.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to return only participants that are muted. Can be: `true` or `false`.", - "in": "query", - "name": "Muted", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to return only participants that are on hold. Can be: `true` or `false`.", - "in": "query", - "name": "Hold", - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to return only participants who are coaching another call. Can be: `true` or `false`.", - "in": "query", - "name": "Coaching", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "participants": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - }, - "type": "array" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListParticipantResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateParticipant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the participant's conference.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Beep": { - "description": "Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", - "type": "string" - }, - "Byoc": { - "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - }, - "CallReason": { - "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)", - "type": "string" - }, - "CallSidToCoach": { - "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "CallerId": { - "description": "The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint.", - "type": "string" - }, - "Coaching": { - "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", - "type": "boolean" - }, - "ConferenceRecord": { - "description": "Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", - "type": "string" - }, - "ConferenceRecordingStatusCallback": { - "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", - "format": "uri", - "type": "string" - }, - "ConferenceRecordingStatusCallbackEvent": { - "description": "The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ConferenceRecordingStatusCallbackMethod": { - "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "ConferenceStatusCallback": { - "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", - "format": "uri", - "type": "string" - }, - "ConferenceStatusCallbackEvent": { - "description": "The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ConferenceStatusCallbackMethod": { - "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "ConferenceTrim": { - "description": "Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", - "type": "string" - }, - "EarlyMedia": { - "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`.", - "type": "boolean" - }, - "EndConferenceOnExit": { - "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "From": { - "description": "The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.", - "type": "string" - }, - "JitterBufferSize": { - "description": "Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`.", - "type": "string" - }, - "Label": { - "description": "A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.", - "type": "string" - }, - "MaxParticipants": { - "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", - "type": "integer" - }, - "Muted": { - "description": "Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "Record": { - "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.", - "type": "boolean" - }, - "RecordingChannels": { - "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", - "type": "string" - }, - "RecordingStatusCallback": { - "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", - "format": "uri", - "type": "string" - }, - "RecordingStatusCallbackEvent": { - "description": "The recording state changes that should generate a call to `recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "RecordingStatusCallbackMethod": { - "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "RecordingTrack": { - "description": "The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio.", - "type": "string" - }, - "Region": { - "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", - "type": "string" - }, - "SipAuthPassword": { - "description": "The SIP password for authentication.", - "type": "string" - }, - "SipAuthUsername": { - "description": "The SIP username used for authentication.", - "type": "string" - }, - "StartConferenceOnEnter": { - "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", - "type": "boolean" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackEvent": { - "description": "The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Timeout": { - "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.", - "type": "integer" - }, - "To": { - "description": "The phone number, SIP address, or Client identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified.", - "type": "string" - }, - "WaitMethod": { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "WaitUrl": { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "format": "uri", - "type": "string" - } - }, - "required": [ - "From", - "To" - ], - "title": "CreateParticipantRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "call_sid", - "label", - "status", - "muted", - "hold" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json": { - "delete": { - "description": "Kick a participant from a given conference", - "operationId": "DeleteParticipant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the conference with the participants to delete.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Conference participants", - "get": { - "description": "Fetch an instance of a participant", - "operationId": "FetchParticipant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the conference with the participant to fetch.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update the properties of the participant", - "operationId": "UpdateParticipant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the conference with the participant to update.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AnnounceMethod": { - "description": "The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "AnnounceUrl": { - "description": "The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `` or `` commands.", - "format": "uri", - "type": "string" - }, - "BeepOnExit": { - "description": "Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.", - "type": "boolean" - }, - "CallSidToCoach": { - "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - }, - "Coaching": { - "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", - "type": "boolean" - }, - "EndConferenceOnExit": { - "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "Hold": { - "description": "Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.", - "type": "boolean" - }, - "HoldMethod": { - "description": "The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "HoldUrl": { - "description": "The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the ``, `` or `` commands.", - "format": "uri", - "type": "string" - }, - "Muted": { - "description": "Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.", - "type": "boolean" - }, - "WaitMethod": { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "WaitUrl": { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateParticipantRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "call_sid", - "label", - "status", - "muted", - "hold" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json": { - "description": "Recordings of conferences", - "get": { - "description": "Retrieve a list of recordings belonging to the call used to make the request", - "operationId": "ListConferenceRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to read.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", - "in": "query", - "name": "DateCreated>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "recordings": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListConferenceRecordingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "conference_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json": { - "delete": { - "description": "Delete a recording from your account", - "operationId": "DeleteConferenceRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to delete.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Recordings of conferences", - "get": { - "description": "Fetch an instance of a recording for a call", - "operationId": "FetchConferenceRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to fetch.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.", - "operationId": "UpdateConferenceRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to update.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "PauseBehavior": { - "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", - "type": "string" - }, - "Status": { - "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "type": "string" - } - }, - "required": [ - "Status" - ], - "title": "UpdateConferenceRecordingRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "conference_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json": { - "description": "Voice call conferences", - "get": { - "description": "Fetch an instance of a conference", - "operationId": "FetchConference", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Conference resource to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "UpdateConference", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Conference resource to update", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AnnounceMethod": { - "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "AnnounceUrl": { - "description": "The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with `` or ``.", - "format": "uri", - "type": "string" - }, - "Status": { - "description": "The new status of the resource. Can be: Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants", - "enum": [ - "completed" - ], - "type": "string" - } - }, - "title": "UpdateConferenceRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/ConnectApps.json": { - "description": "Twilio Connect apps", - "get": { - "description": "Retrieve a list of connect-apps belonging to the account used to make the request", - "operationId": "ListConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "connect_apps": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListConnectAppResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json": { - "delete": { - "description": "Delete an instance of a connect-app", - "operationId": "DeleteConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Twilio Connect apps", - "get": { - "description": "Fetch an instance of a connect-app", - "operationId": "FetchConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update a connect-app with the specified parameters", - "operationId": "UpdateConnectApp", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the ConnectApp resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AuthorizeRedirectUrl": { - "description": "The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", - "format": "uri", - "type": "string" - }, - "CompanyName": { - "description": "The company name to set for the Connect App.", - "type": "string" - }, - "DeauthorizeCallbackMethod": { - "description": "The HTTP method to use when calling `deauthorize_callback_url`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "DeauthorizeCallbackUrl": { - "description": "The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App.", - "format": "uri", - "type": "string" - }, - "Description": { - "description": "A description of the Connect App.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "HomepageUrl": { - "description": "A public URL where users can obtain more information about this Connect App.", - "format": "uri", - "type": "string" - }, - "Permissions": { - "description": "A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.", - "items": { - "enum": [ - "get-all", - "post-all" - ], - "type": "string" - }, - "type": "array" - } - }, - "title": "UpdateConnectAppRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { - "description": "Incoming phone numbers on a Twilio account/project", - "get": { - "description": "Retrieve a list of incoming-phone-numbers belonging to the account used to make the request.", - "operationId": "ListIncomingPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the IncomingPhoneNumber resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "incoming_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Purchase a phone-number for the account.", - "operationId": "CreateIncomingPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "ApiVersion": { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "type": "string" - }, - "AreaCode": { - "description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).", - "type": "string" - }, - "BundleSid": { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyAddressSid": { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyStatus": { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.", - "type": "string" - }, - "IdentitySid": { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "type": "string" - }, - "SmsApplicationSid": { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "TrunkSid": { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceApplicationSid": { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceReceiveMode": { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "enum": [ - "voice", - "fax" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "format": "uri", - "type": "string" - } - }, - "title": "CreateIncomingPhoneNumberRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { - "description": "Incoming local phone numbers on a Twilio account/project", - "get": { - "description": "", - "operationId": "ListIncomingPhoneNumberLocal", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "incoming_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberLocalResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateIncomingPhoneNumberLocal", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "ApiVersion": { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "type": "string" - }, - "BundleSid": { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyAddressSid": { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyStatus": { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "type": "string" - }, - "IdentitySid": { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "type": "string" - }, - "SmsApplicationSid": { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "TrunkSid": { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceApplicationSid": { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceReceiveMode": { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "enum": [ - "voice", - "fax" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "PhoneNumber" - ], - "title": "CreateIncomingPhoneNumberLocalRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json": { - "description": "Incoming mobile phone numbers on a Twilio account/project", - "get": { - "description": "", - "operationId": "ListIncomingPhoneNumberMobile", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "incoming_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberMobileResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateIncomingPhoneNumberMobile", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "ApiVersion": { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "type": "string" - }, - "BundleSid": { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyAddressSid": { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyStatus": { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.", - "type": "string" - }, - "IdentitySid": { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "type": "string" - }, - "SmsApplicationSid": { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "TrunkSid": { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceApplicationSid": { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceReceiveMode": { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "enum": [ - "voice", - "fax" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "PhoneNumber" - ], - "title": "CreateIncomingPhoneNumberMobileRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json": { - "description": "Incoming toll free phone numbers on a Twilio account/project", - "get": { - "description": "", - "operationId": "ListIncomingPhoneNumberTollFree", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "incoming_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberTollFreeResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateIncomingPhoneNumberTollFree", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressSid": { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "ApiVersion": { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "type": "string" - }, - "BundleSid": { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyAddressSid": { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyStatus": { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "type": "string" - }, - "IdentitySid": { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "type": "string" - }, - "SmsApplicationSid": { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "TrunkSid": { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceApplicationSid": { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceReceiveMode": { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "enum": [ - "voice", - "fax" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "PhoneNumber" - ], - "title": "CreateIncomingPhoneNumberTollFreeRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Add-on installations currently assigned to this Number.", - "operationId": "ListIncomingPhoneNumberAssignedAddOn", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "assigned_add_ons": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberAssignedAddOnResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "post": { - "description": "Assign an Add-on installation to the Number specified.", - "operationId": "CreateIncomingPhoneNumberAssignedAddOn", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to assign the Add-on.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "InstalledAddOnSid": { - "description": "The SID that identifies the Add-on installation.", - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "InstalledAddOnSid" - ], - "title": "CreateIncomingPhoneNumberAssignedAddOnRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name", - "description" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Extensions for the Assigned Add-on.", - "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID that uniquely identifies the assigned Add-on installation.", - "in": "path", - "name": "AssignedAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "extensions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" - }, - "type": "array" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name", - "product_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Extension for the Assigned Add-on.", - "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID that uniquely identifies the assigned Add-on installation.", - "in": "path", - "name": "AssignedAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name", - "product_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json": { - "delete": { - "description": "Remove the assignment of an Add-on installation from the Number specified.", - "operationId": "DeleteIncomingPhoneNumberAssignedAddOn", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Add-on installation currently assigned to this Number.", - "operationId": "FetchIncomingPhoneNumberAssignedAddOn", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "Beta" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name", - "description" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { - "delete": { - "description": "Delete a phone-numbers belonging to the account used to make the request.", - "operationId": "DeleteIncomingPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Incoming phone numbers on a Twilio account/project", - "get": { - "description": "Fetch an incoming-phone-number belonging to the account used to make the request.", - "operationId": "FetchIncomingPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update an incoming-phone-number instance.", - "operationId": "UpdateIncomingPhoneNumber", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AccountSid": { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - }, - "AddressSid": { - "description": "The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "ApiVersion": { - "description": "The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.", - "type": "string" - }, - "BundleSid": { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyAddressSid": { - "description": "The SID of the emergency address configuration to use for emergency calling from this phone number.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyStatus": { - "description": "The configuration status parameter that determines whether the phone number is enabled for emergency calling.", - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "type": "string" - }, - "IdentitySid": { - "description": "The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.", - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsApplicationSid": { - "description": "The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when the phone number receives an incoming SMS message.", - "format": "uri", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "TrunkSid": { - "description": "The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^TK[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceApplicationSid": { - "description": "The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "VoiceCallerIdLookup": { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceReceiveMode": { - "description": "The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "enum": [ - "voice", - "fax" - ], - "type": "string" - }, - "VoiceUrl": { - "description": "The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateIncomingPhoneNumberRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Keys.json": { - "description": "API keys", - "get": { - "description": "", - "operationId": "ListKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "keys": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.key" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListKeyResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateNewKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "title": "CreateNewKeyRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.new_key" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json": { - "delete": { - "description": "", - "operationId": "DeleteKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Key resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "API keys", - "get": { - "description": "", - "operationId": "FetchKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Key resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "UpdateKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Key resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "title": "UpdateKeyRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages.json": { - "description": "A Message resource represents an inbound or outbound message.", - "get": { - "description": "Retrieve a list of messages belonging to the account used to make the request", - "operationId": "ListMessage", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Read messages sent to only this phone number.", - "in": "query", - "name": "To", - "schema": { - "type": "string" - } - }, - { - "description": "Read messages sent from only this phone number or alphanumeric sender ID.", - "in": "query", - "name": "From", - "schema": { - "type": "string" - } - }, - { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", - "in": "query", - "name": "DateSent", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", - "in": "query", - "name": "DateSent<", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", - "in": "query", - "name": "DateSent>", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "messages": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.message" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListMessageResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Send a message from the account used to make the request", - "operationId": "CreateMessage", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "AddressRetention": { - "description": "Determines if the address can be stored or obfuscated based on privacy settings", - "enum": [ - "retain" - ], - "type": "string" - }, - "ApplicationSid": { - "description": "The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - }, - "Attempt": { - "description": "Total number of attempts made ( including this ) to send out the message regardless of the provider used", - "type": "integer" - }, - "Body": { - "description": "The text of the message you want to send. Can be up to 1,600 characters in length.", - "type": "string" - }, - "ContentRetention": { - "description": "Determines if the message content can be stored or redacted based on privacy settings", - "enum": [ - "retain" - ], - "type": "string" - }, - "ForceDelivery": { - "description": "Reserved", - "type": "boolean" - }, - "From": { - "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty.", - "type": "string" - }, - "MaxPrice": { - "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked.", - "type": "number" - }, - "MediaUrl": { - "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada.", - "items": { - "format": "uri", - "type": "string" - }, - "type": "array" - }, - "MessagingServiceSid": { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery.", - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - }, - "PersistentAction": { - "description": "Rich actions for Channels Messages.", - "items": { - "type": "string" - }, - "type": "array" - }, - "ProvideFeedback": { - "description": "Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default.", - "type": "boolean" - }, - "SmartEncoded": { - "description": "Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`.", - "type": "boolean" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed.", - "format": "uri", - "type": "string" - }, - "To": { - "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels.", - "type": "string" - }, - "ValidityPeriod": { - "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds.", - "type": "integer" - } - }, - "required": [ - "To" - ], - "title": "CreateMessageRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "status", - "direction", - "date_sent" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json": { - "description": "Customer-provided feedback on delivery confirmation", - "post": { - "description": "", - "operationId": "CreateMessageFeedback", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource for which the feedback was provided.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Outcome": { - "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.", - "enum": [ - "confirmed", - "unconfirmed" - ], - "type": "string" - } - }, - "title": "CreateMessageFeedbackRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message.message_feedback" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "message_sid", - "outcome", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", - "get": { - "description": "Retrieve a list of Media resources belonging to the account used to make the request", - "operationId": "ListMedia", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated<", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated>", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "media_list": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.message.media" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListMediaResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "parent_sid", - "content_type" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json": { - "delete": { - "description": "Delete media from your account. Once delete, you will no longer be billed", - "operationId": "DeleteMedia", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Media resource to delete", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", - "get": { - "description": "Fetch a single media instance belonging to the account used to make the request", - "operationId": "FetchMedia", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Media resource to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message.media" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "parent_sid", - "content_type" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { - "delete": { - "description": "Deletes a message record from your account", - "operationId": "DeleteMessage", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "A Message resource represents an inbound or outbound message.", - "get": { - "description": "Fetch a message belonging to the account used to make the request", - "operationId": "FetchMessage", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "To redact a message-body from a post-flight message record, post to the message instance resource with an empty body", - "operationId": "UpdateMessage", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Body": { - "description": "The text of the message you want to send. Can be up to 1,600 characters long.", - "type": "string" - } - }, - "required": [ - "Body" - ], - "title": "UpdateMessageRequest", - "type": "object" - } - } - } - }, - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" - } - } - }, - "description": "Accepted" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "from", - "to", - "status", - "direction", - "date_sent" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { - "description": "[DEPRECATED] Log entries", - "get": { - "description": "Retrieve a list of notifications belonging to the account used to make the request", - "operationId": "ListNotification", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", - "in": "query", - "name": "Log", - "schema": { - "type": "integer" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate<", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate>", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "notifications": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.notification" - }, - "type": "array" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListNotificationResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { - "description": "[DEPRECATED] Log entries", - "get": { - "description": "Fetch a notification belonging to the account used to make the request", - "operationId": "FetchNotification", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Notification resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.notification-instance" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { - "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", - "get": { - "description": "Retrieve a list of outgoing-caller-ids belonging to the account used to make the request", - "operationId": "ListOutgoingCallerId", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The phone number of the OutgoingCallerId resources to read.", - "in": "query", - "name": "PhoneNumber", - "schema": { - "type": "string" - } - }, - { - "description": "The string that identifies the OutgoingCallerId resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "outgoing_caller_ids": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" - }, - "type": "array" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListOutgoingCallerIdResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "CreateValidationRequest", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the new caller ID resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallDelay": { - "description": "The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`.", - "type": "integer" - }, - "Extension": { - "description": "The digits to dial after connecting the verification call.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.", - "type": "string" - }, - "PhoneNumber": { - "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "type": "string" - }, - "StatusCallback": { - "description": "The URL we should call using the `status_callback_method` to send status information about the verification process to your application.", - "format": "uri", - "type": "string" - }, - "StatusCallbackMethod": { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - "required": [ - "PhoneNumber" - ], - "title": "CreateValidationRequestRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.validation_request" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { - "delete": { - "description": "Delete the caller-id specified from the account", - "operationId": "DeleteOutgoingCallerId", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", - "get": { - "description": "Fetch an outgoing-caller-id belonging to the account used to make the request", - "operationId": "FetchOutgoingCallerId", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Updates the caller-id", - "operationId": "UpdateOutgoingCallerId", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "title": "UpdateOutgoingCallerIdRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Queues.json": { - "description": "Queues of calls", - "get": { - "description": "Retrieve a list of queues belonging to the account used to make the request", - "operationId": "ListQueue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "queues": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListQueueResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a queue", - "operationId": "CreateQueue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", - "type": "string" - }, - "MaxSize": { - "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", - "type": "integer" - } - }, - "required": [ - "FriendlyName" - ], - "title": "CreateQueueRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "current_size", - "average_wait_time" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json": { - "description": "Calls in a call queue", - "get": { - "description": "Retrieve the members of the queue", - "operationId": "ListMember", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Queue in which to find the members", - "in": "path", - "name": "QueueSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "queue_members": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListMemberResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "call_sid", - "date_enqueued", - "position", - "wait_time" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { - "description": "Calls in a call queue", - "get": { - "description": "Fetch a specific member from the queue", - "operationId": "FetchMember", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Queue in which to find the members to fetch.", - "in": "path", - "name": "QueueSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL", - "operationId": "UpdateMember", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Queue in which to find the members to update.", - "in": "path", - "name": "QueueSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Method": { - "description": "How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "Url": { - "description": "The absolute URL of the Queue resource.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "Url" - ], - "title": "UpdateMemberRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "call_sid", - "date_enqueued", - "position", - "wait_time" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json": { - "delete": { - "description": "Remove an empty queue", - "operationId": "DeleteQueue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to delete", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Queues of calls", - "get": { - "description": "Fetch an instance of a queue identified by the QueueSid", - "operationId": "FetchQueue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update the queue with the new parameters", - "operationId": "UpdateQueue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to update", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", - "type": "string" - }, - "MaxSize": { - "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", - "type": "integer" - } - }, - "title": "UpdateQueueRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "current_size", - "average_wait_time" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { - "description": "Recordings of phone calls", - "get": { - "description": "Retrieve a list of recordings belonging to the account used to make the request", - "operationId": "ListRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated<", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated>", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read.", - "in": "query", - "name": "CallSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to read.", - "in": "query", - "name": "ConferenceSid", - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "recordings": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListRecordingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { - "description": "References to text transcriptions of call recordings", - "get": { - "description": "", - "operationId": "ListRecordingTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcriptions to read.", - "in": "path", - "name": "RecordingSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "transcriptions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" - }, - "type": "array" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListRecordingTranscriptionResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { - "delete": { - "description": "", - "operationId": "DeleteRecordingTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to delete.", - "in": "path", - "name": "RecordingSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "References to text transcriptions of call recordings", - "get": { - "description": "", - "operationId": "FetchRecordingTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to fetch.", - "in": "path", - "name": "RecordingSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { - "description": "The results of an Add-on API call", - "get": { - "description": "Retrieve a list of results belonging to the recording", - "operationId": "ListRecordingAddOnResult", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the result to read belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "add_on_results": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListRecordingAddOnResultResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "status", - "add_on_sid", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { - "description": "A single Add-on results' payload", - "get": { - "description": "Retrieve a list of payloads belonging to the AddOnResult", - "operationId": "ListRecordingAddOnResultPayload", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AddOnResult to which the payloads to read belongs.", - "in": "path", - "name": "AddOnResultSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "payloads": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - }, - "type": "array" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListRecordingAddOnResultPayloadResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "label", - "content_type" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { - "delete": { - "description": "Delete a payload from the result along with all associated Data", - "operationId": "DeleteRecordingAddOnResultPayload", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AddOnResult to which the payloads to delete belongs.", - "in": "path", - "name": "AddOnResultSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XH[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "A single Add-on results' payload", - "get": { - "description": "Fetch an instance of a result payload", - "operationId": "FetchRecordingAddOnResultPayload", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AddOnResult to which the payload to fetch belongs.", - "in": "path", - "name": "AddOnResultSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XH[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "label", - "content_type" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { - "delete": { - "description": "Delete a result and purge all associated Payloads", - "operationId": "DeleteRecordingAddOnResult", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the result to delete belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "The results of an Add-on API call", - "get": { - "description": "Fetch an instance of an AddOnResult", - "operationId": "FetchRecordingAddOnResult", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the result to fetch belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "status", - "add_on_sid", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json": { - "delete": { - "description": "Delete a recording from your account", - "operationId": "DeleteRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Recordings of phone calls", - "get": { - "description": "Fetch an instance of a recording", - "operationId": "FetchRecording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "status", - "start_time", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json": { - "description": "Lists of SIP credentials", - "get": { - "description": "Get All Credential Lists", - "operationId": "ListSipCredentialList", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "credential_lists": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipCredentialListResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a Credential List", - "operationId": "CreateSipCredentialList", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A human readable descriptive text that describes the CredentialList, up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "title": "CreateSipCredentialListRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json": { - "description": "Username and password information for SIP Domains", - "get": { - "description": "Retrieve a list of credentials.", - "operationId": "ListSipCredential", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the credential list that contains the desired credentials.", - "in": "path", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "credentials": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipCredentialResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new credential resource.", - "operationId": "CreateSipCredential", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the credential list to include the created credential.", - "in": "path", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Password": { - "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", - "type": "string" - }, - "Username": { - "description": "The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.", - "type": "string" - } - }, - "required": [ - "Username", - "Password" - ], - "title": "CreateSipCredentialRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "username", - "credential_list_sid" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json": { - "delete": { - "description": "Delete a credential resource.", - "operationId": "DeleteSipCredential", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the credential list that contains the desired credentials.", - "in": "path", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Username and password information for SIP Domains", - "get": { - "description": "Fetch a single credential.", - "operationId": "FetchSipCredential", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the credential list that contains the desired credential.", - "in": "path", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update a credential resource.", - "operationId": "UpdateSipCredential", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the credential list that includes this credential.", - "in": "path", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique id that identifies the resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Password": { - "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", - "type": "string" - } - }, - "title": "UpdateSipCredentialRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "username", - "credential_list_sid" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json": { - "delete": { - "description": "Delete a Credential List", - "operationId": "DeleteSipCredentialList", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The credential list Sid that uniquely identifies this resource", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Lists of SIP credentials", - "get": { - "description": "Get a Credential List", - "operationId": "FetchSipCredentialList", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The credential list Sid that uniquely identifies this resource", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update a Credential List", - "operationId": "UpdateSipCredentialList", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The credential list Sid that uniquely identifies this resource", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A human readable descriptive text for a CredentialList, up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "title": "UpdateSipCredentialListRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json": { - "description": "Custom DNS hostnames that can accept SIP traffic", - "get": { - "description": "Retrieve a list of domains belonging to the account used to make the request", - "operationId": "ListSipDomain", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "domains": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipDomainResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new Domain", - "operationId": "CreateSipDomain", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ByocTrunkSid": { - "description": "The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - }, - "DomainName": { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`.", - "type": "string" - }, - "EmergencyCallerSid": { - "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.", - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyCallingEnabled": { - "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", - "type": "boolean" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "Secure": { - "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", - "type": "boolean" - }, - "SipRegistration": { - "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceStatusCallbackMethod": { - "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceStatusCallbackUrl": { - "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", - "format": "uri", - "type": "string" - }, - "VoiceUrl": { - "description": "The URL we should when the domain receives a call.", - "format": "uri", - "type": "string" - } - }, - "required": [ - "DomainName" - ], - "title": "CreateSipDomainRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "domain_name", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json": { - "description": "Credential lists for SIP calls", - "get": { - "description": "Retrieve a list of credential list mappings belonging to the domain used in the request", - "operationId": "ListSipAuthCallsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resources to read.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "contents": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipAuthCallsCredentialListMappingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new credential list mapping resource", - "operationId": "CreateSipAuthCallsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that will contain the new resource.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CredentialListSid": { - "description": "The SID of the CredentialList resource to map to the SIP domain.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "CredentialListSid" - ], - "title": "CreateSipAuthCallsCredentialListMappingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json": { - "delete": { - "description": "Delete a credential list mapping from the requested domain", - "operationId": "DeleteSipAuthCallsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resource to delete.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Credential lists for SIP calls", - "get": { - "description": "Fetch a specific instance of a credential list mapping", - "operationId": "FetchSipAuthCallsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resource to fetch.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json": { - "description": "IP address lists for SIP calls", - "get": { - "description": "Retrieve a list of IP Access Control List mappings belonging to the domain used in the request", - "operationId": "ListSipAuthCallsIpAccessControlListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resources to read.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "contents": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipAuthCallsIpAccessControlListMappingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new IP Access Control List mapping", - "operationId": "CreateSipAuthCallsIpAccessControlListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that will contain the new resource.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "IpAccessControlListSid": { - "description": "The SID of the IpAccessControlList resource to map to the SIP domain.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "IpAccessControlListSid" - ], - "title": "CreateSipAuthCallsIpAccessControlListMappingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json": { - "delete": { - "description": "Delete an IP Access Control List mapping from the requested domain", - "operationId": "DeleteSipAuthCallsIpAccessControlListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resources to delete.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "IP address lists for SIP calls", - "get": { - "description": "Fetch a specific instance of an IP Access Control List mapping", - "operationId": "FetchSipAuthCallsIpAccessControlListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resource to fetch.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json": { - "description": "Credential lists for SIP registrations", - "get": { - "description": "Retrieve a list of credential list mappings belonging to the domain used in the request", - "operationId": "ListSipAuthRegistrationsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resources to read.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "contents": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipAuthRegistrationsCredentialListMappingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new credential list mapping resource", - "operationId": "CreateSipAuthRegistrationsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that will contain the new resource.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CredentialListSid": { - "description": "The SID of the CredentialList resource to map to the SIP domain.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "CredentialListSid" - ], - "title": "CreateSipAuthRegistrationsCredentialListMappingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json": { - "delete": { - "description": "Delete a credential list mapping from the requested domain", - "operationId": "DeleteSipAuthRegistrationsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resources to delete.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Credential lists for SIP registrations", - "get": { - "description": "Fetch a specific instance of a credential list mapping", - "operationId": "FetchSipAuthRegistrationsCredentialListMapping", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the SIP domain that contains the resource to fetch.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json": { - "description": "Credential lists associated with a SIP Domain", - "get": { - "description": "Read multiple CredentialListMapping resources from an account.", - "operationId": "ListSipCredentialListMapping", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to read.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "credential_list_mappings": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipCredentialListMappingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a CredentialListMapping resource for an account.", - "operationId": "CreateSipCredentialListMapping", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CredentialListSid": { - "description": "A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.", - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "CredentialListSid" - ], - "title": "CreateSipCredentialListMappingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json": { - "delete": { - "description": "Delete a CredentialListMapping resource from an account.", - "operationId": "DeleteSipCredentialListMapping", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Credential lists associated with a SIP Domain", - "get": { - "description": "Fetch a single CredentialListMapping resource from an account.", - "operationId": "FetchSipCredentialListMapping", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json": { - "description": "Access control lists associated with a SIP Domain", - "get": { - "description": "Retrieve a list of IpAccessControlListMapping resources.", - "operationId": "ListSipIpAccessControlListMapping", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP domain.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "ip_access_control_list_mappings": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipIpAccessControlListMappingResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new IpAccessControlListMapping resource.", - "operationId": "CreateSipIpAccessControlListMapping", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP domain.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "IpAccessControlListSid": { - "description": "The unique id of the IP access control list to map to the SIP domain.", - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - "required": [ - "IpAccessControlListSid" - ], - "title": "CreateSipIpAccessControlListMappingRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json": { - "delete": { - "description": "Delete an IpAccessControlListMapping resource.", - "operationId": "DeleteSipIpAccessControlListMapping", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP domain.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Access control lists associated with a SIP Domain", - "get": { - "description": "Fetch an IpAccessControlListMapping resource.", - "operationId": "FetchSipIpAccessControlListMapping", - "parameters": [ - { - "description": "The unique id of the Account that is responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the SIP domain.", - "in": "path", - "name": "DomainSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json": { - "delete": { - "description": "Delete an instance of a Domain", - "operationId": "DeleteSipDomain", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the SipDomain resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Custom DNS hostnames that can accept SIP traffic", - "get": { - "description": "Fetch an instance of a Domain", - "operationId": "FetchSipDomain", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update the attributes of a domain", - "operationId": "UpdateSipDomain", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the SipDomain resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SD[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ByocTrunkSid": { - "description": "The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.", - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - }, - "DomainName": { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`.", - "type": "string" - }, - "EmergencyCallerSid": { - "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.", - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - }, - "EmergencyCallingEnabled": { - "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", - "type": "boolean" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "Secure": { - "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", - "type": "boolean" - }, - "SipRegistration": { - "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", - "type": "boolean" - }, - "VoiceFallbackMethod": { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceFallbackUrl": { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`.", - "format": "uri", - "type": "string" - }, - "VoiceMethod": { - "description": "The HTTP method we should use to call `voice_url`", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceStatusCallbackMethod": { - "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "VoiceStatusCallbackUrl": { - "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", - "format": "uri", - "type": "string" - }, - "VoiceUrl": { - "description": "The URL we should call when the domain receives a call.", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateSipDomainRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "domain_name", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json": { - "description": "Access control lists of IP address resources", - "get": { - "description": "Retrieve a list of IpAccessControlLists that belong to the account used to make the request", - "operationId": "ListSipIpAccessControlList", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "ip_access_control_lists": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipIpAccessControlListResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new IpAccessControlList resource", - "operationId": "CreateSipIpAccessControlList", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A human readable descriptive text that describes the IpAccessControlList, up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "title": "CreateSipIpAccessControlListRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json": { - "description": "IP addresses that have access to a SIP Domain", - "get": { - "description": "Read multiple IpAddress resources.", - "operationId": "ListSipIpAddress", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The IpAccessControlList Sid that identifies the IpAddress resources to read.", - "in": "path", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "ip_addresses": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSipIpAddressResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new IpAddress resource.", - "operationId": "CreateSipIpAddress", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The IpAccessControlList Sid with which to associate the created IpAddress resource.", - "in": "path", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CidrPrefixLength": { - "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", - "type": "integer" - }, - "FriendlyName": { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "type": "string" - }, - "IpAddress": { - "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", - "type": "string" - } - }, - "required": [ - "FriendlyName", - "IpAddress" - ], - "title": "CreateSipIpAddressRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "ip_address", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json": { - "delete": { - "description": "Delete an IpAddress resource.", - "operationId": "DeleteSipIpAddress", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The IpAccessControlList Sid that identifies the IpAddress resources to delete.", - "in": "path", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "IP addresses that have access to a SIP Domain", - "get": { - "description": "Read one IpAddress resource.", - "operationId": "FetchSipIpAddress", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The IpAccessControlList Sid that identifies the IpAddress resources to fetch.", - "in": "path", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the IpAddress resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update an IpAddress resource.", - "operationId": "UpdateSipIpAddress", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The IpAccessControlList Sid that identifies the IpAddress resources to update.", - "in": "path", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that identifies the IpAddress resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IP[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CidrPrefixLength": { - "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", - "type": "integer" - }, - "FriendlyName": { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "type": "string" - }, - "IpAddress": { - "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", - "type": "string" - } - }, - "title": "UpdateSipIpAddressRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "ip_address", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json": { - "delete": { - "description": "Delete an IpAccessControlList from the requested account", - "operationId": "DeleteSipIpAccessControlList", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Access control lists of IP address resources", - "get": { - "description": "Fetch a specific instance of an IpAccessControlList", - "operationId": "FetchSipIpAccessControlList", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Rename an IpAccessControlList", - "operationId": "UpdateSipIpAccessControlList", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies the resource to udpate.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A human readable descriptive text, up to 64 characters long.", - "type": "string" - } - }, - "required": [ - "FriendlyName" - ], - "title": "UpdateSipIpAccessControlListRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json": { - "description": "Messaging short codes", - "get": { - "description": "Retrieve a list of short-codes belonging to the account used to make the request", - "operationId": "ListShortCode", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The string that identifies the ShortCode resources to read.", - "in": "query", - "name": "FriendlyName", - "schema": { - "type": "string" - } - }, - { - "description": "Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "ShortCode", - "schema": { - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "short_codes": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.short_code" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListShortCodeResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "short_code", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json": { - "description": "Messaging short codes", - "get": { - "description": "Fetch an instance of a short code", - "operationId": "FetchShortCode", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the ShortCode resource to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.short_code" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update a short code with the following parameters", - "operationId": "UpdateShortCode", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the ShortCode resource to update", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "ApiVersion": { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`.", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code.", - "type": "string" - }, - "SmsFallbackMethod": { - "description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsFallbackUrl": { - "description": "The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`.", - "format": "uri", - "type": "string" - }, - "SmsMethod": { - "description": "The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "SmsUrl": { - "description": "The URL we should call when receiving an incoming SMS message to this short code.", - "format": "uri", - "type": "string" - } - }, - "title": "UpdateShortCodeRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.short_code" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "short_code", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/SigningKeys.json": { - "description": "Create a new signing key", - "get": { - "description": "", - "operationId": "ListSigningKey", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "signing_keys": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.signing_key" - }, - "type": "array" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListSigningKeyResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new Signing Key for the account making the request.", - "operationId": "CreateNewSigningKey", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "title": "CreateNewSigningKeyRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.new_signing_key" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "secret" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json": { - "delete": { - "description": "", - "operationId": "DeleteSigningKey", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "operationId": "FetchSigningKey", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.signing_key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "", - "operationId": "UpdateSigningKey", - "parameters": [ - { - "description": "", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "", - "type": "string" - } - }, - "title": "UpdateSigningKeyRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.signing_key" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Tokens.json": { - "description": "Credentials for ICE servers", - "post": { - "description": "Create a new token for ICE servers", - "operationId": "CreateToken", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "Ttl": { - "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours).", - "type": "integer" - } - }, - "title": "CreateTokenRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.token" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "username", - "ice_servers" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { - "description": "Text transcriptions of call recordings", - "get": { - "description": "Retrieve a list of transcriptions belonging to the account used to make the request", - "operationId": "ListTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "transcriptions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.transcription" - }, - "type": "array" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "title": "ListTranscriptionResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json": { - "delete": { - "description": "Delete a transcription from the account used to make the request", - "operationId": "DeleteTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Text transcriptions of call recordings", - "get": { - "description": "Fetch an instance of a Transcription", - "operationId": "FetchTranscription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.transcription" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records.json": { - "description": "Twilio account usage records", - "get": { - "description": "Retrieve a list of usage-records belonging to the account used to make the request", - "operationId": "ListUsageRecord", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" - }, - "type": "array" - } - }, - "title": "ListUsageRecordResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { - "description": "Usage records for all time", - "get": { - "description": "", - "operationId": "ListUsageRecordAllTime", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" - }, - "type": "array" - } - }, - "title": "ListUsageRecordAllTimeResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { - "description": "Usage records summarized by day", - "get": { - "description": "", - "operationId": "ListUsageRecordDaily", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" - }, - "type": "array" - } - }, - "title": "ListUsageRecordDailyResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { - "description": "Usage records for last month", - "get": { - "description": "", - "operationId": "ListUsageRecordLastMonth", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" - }, - "type": "array" - } - }, - "title": "ListUsageRecordLastMonthResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { - "description": "Usage records summarized by month", - "get": { - "description": "", - "operationId": "ListUsageRecordMonthly", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" - }, - "type": "array" - } - }, - "title": "ListUsageRecordMonthlyResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { - "description": "Usage records for this month", - "get": { - "description": "", - "operationId": "ListUsageRecordThisMonth", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" - }, - "type": "array" - } - }, - "title": "ListUsageRecordThisMonthResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { - "description": "Usage records for today", - "get": { - "description": "", - "operationId": "ListUsageRecordToday", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" - }, - "type": "array" - } - }, - "title": "ListUsageRecordTodayResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { - "description": "Usage records summarized by year", - "get": { - "description": "", - "operationId": "ListUsageRecordYearly", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" - }, - "type": "array" - } - }, - "title": "ListUsageRecordYearlyResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { - "description": "Usage records for yesterday", - "get": { - "description": "", - "operationId": "ListUsageRecordYesterday", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "schema": { - "format": "date", - "type": "string" - } - }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "schema": { - "type": "boolean" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" - }, - "type": "array" - } - }, - "title": "ListUsageRecordYesterdayResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { - "description": "Webhooks that notify you of usage thresholds", - "get": { - "description": "Retrieve a list of usage-triggers belonging to the account used to make the request", - "operationId": "ListUsageTrigger", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.", - "in": "query", - "name": "Recurring", - "schema": { - "enum": [ - "daily", - "monthly", - "yearly", - "alltime" - ], - "type": "string" - } - }, - { - "description": "The trigger field of the UsageTriggers to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).", - "in": "query", - "name": "TriggerBy", - "schema": { - "enum": [ - "count", - "usage", - "price" - ], - "type": "string" - } - }, - { - "description": "The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).", - "in": "query", - "name": "UsageCategory", - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_triggers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" - }, - "type": "array" - } - }, - "title": "ListUsageTriggerResponse", - "type": "object" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Create a new UsageTrigger", - "operationId": "CreateUsageTrigger", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "CallbackUrl": { - "description": "The URL we should call using `callback_method` when the trigger fires.", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - }, - "Recurring": { - "description": "The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.", - "enum": [ - "daily", - "monthly", - "yearly", - "alltime" - ], - "type": "string" - }, - "TriggerBy": { - "description": "The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that should fire the trigger. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). The default is `usage`.", - "enum": [ - "count", - "usage", - "price" - ], - "type": "string" - }, - "TriggerValue": { - "description": "The usage value at which the trigger should fire. For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`.", - "type": "string" - }, - "UsageCategory": { - "description": "The usage category that the trigger should watch. Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value.", - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "imp-v1-usage", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-convriza-ababa", - "marketplace-deepgram-phrase-detector", - "marketplace-digital-segment-business-info", - "marketplace-facebook-offline-conversions", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfarm-spoken-results", - "marketplace-wolfram-short-answer", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-users", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pstnconnectivity", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-bandwidth", - "rooms-group-minutes", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "verify-push", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-sms", - "wireless-usage-voice" - ], - "type": "string" - } - }, - "required": [ - "CallbackUrl", - "TriggerValue", - "UsageCategory" - ], - "title": "CreateUsageTriggerRequest", - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "usage_category", - "trigger_by" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json": { - "delete": { - "description": "", - "operationId": "DeleteUsageTrigger", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UT[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "description": "Webhooks that notify you of usage thresholds", - "get": { - "description": "Fetch and instance of a usage-trigger", - "operationId": "FetchUsageTrigger", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UT[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Update an instance of a usage trigger", - "operationId": "UpdateUsageTrigger", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the UsageTrigger resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UT[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "CallbackMethod": { - "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - }, - "CallbackUrl": { - "description": "The URL we should call using `callback_method` when the trigger fires.", - "format": "uri", - "type": "string" - }, - "FriendlyName": { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "type": "string" - } - }, - "title": "UpdateUsageTriggerRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "usage_category", - "trigger_by" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{Sid}.json": { - "description": "Twilio accounts (aka Project) or subaccounts", - "get": { - "description": "Fetch the account specified by the provided Account Sid", - "operationId": "FetchAccount", - "parameters": [ - { - "description": "The Account Sid that uniquely identifies the account to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "post": { - "description": "Modify the properties of a given Account", - "operationId": "UpdateAccount", - "parameters": [ - { - "description": "The Account Sid that uniquely identifies the account to update", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "FriendlyName": { - "description": "Update the human-readable description of this Account", - "type": "string" - }, - "Status": { - "description": "Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.", - "enum": [ - "active", - "suspended", - "closed" - ], - "type": "string" - } - }, - "title": "UpdateAccountRequest", - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "x-maturity": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "status" - ], - "x-path-type": "instance" - } - }, - "x-maturity": [ - { - "description": "This product is Generally Available.", - "name": "GA" - }, - { - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution.", - "name": "Beta" - }, - { - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.", - "name": "Preview" - } - ] - } \ No newline at end of file diff --git a/test/blackbox/docs/Swagger-2_0/petstore.json b/test/blackbox/docs/Swagger-2_0/petstore.json deleted file mode 100644 index 88b62c47d2..0000000000 --- a/test/blackbox/docs/Swagger-2_0/petstore.json +++ /dev/null @@ -1,1054 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.5", - "title": "Swagger Petstore", - "termsOfService": "http://swagger.io/terms/", - "contact": { - "email": "apiteam@swagger.io" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "host": "petstore.swagger.io", - "basePath": "/v2", - "tags": [ - { - "name": "pet", - "description": "Everything about your Pets", - "externalDocs": { - "description": "Find out more", - "url": "http://swagger.io" - } - }, - { - "name": "store", - "description": "Access to Petstore orders" - }, - { - "name": "user", - "description": "Operations about user", - "externalDocs": { - "description": "Find out more about our store", - "url": "http://swagger.io" - } - } - ], - "schemes": [ - "https", - "http" - ], - "paths": { - "/pet/{petId}/uploadImage": { - "post": { - "tags": [ - "pet" - ], - "summary": "uploads an image", - "description": "", - "operationId": "uploadFile", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "additionalMetadata", - "in": "formData", - "description": "Additional data to pass to server", - "required": false, - "type": "string" - }, - { - "name": "file", - "in": "formData", - "description": "file to upload", - "required": false, - "type": "file" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet": { - "post": { - "tags": [ - "pet" - ], - "summary": "Add a new pet to the store", - "description": "", - "operationId": "addPet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "put": { - "tags": [ - "pet" - ], - "summary": "Update an existing pet", - "description": "", - "operationId": "updatePet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": true, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "405": { - "description": "Validation exception" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByStatus": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by status", - "description": "Multiple status values can be provided with comma separated strings", - "operationId": "findPetsByStatus", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": true, - "type": "array", - "items": { - "type": "string", - "enum": [ - "available", - "pending", - "sold" - ], - "default": "available" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid status value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/pet/findByTags": { - "get": { - "tags": [ - "pet" - ], - "summary": "Finds Pets by tags", - "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", - "operationId": "findPetsByTags", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid tag value" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ], - "deprecated": true - } - }, - "/pet/{petId}": { - "get": { - "tags": [ - "pet" - ], - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Pet" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "api_key": [] - } - ] - }, - "post": { - "tags": [ - "pet" - ], - "summary": "Updates a pet in the store with form data", - "description": "", - "operationId": "updatePetWithForm", - "consumes": [ - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet that needs to be updated", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "name", - "in": "formData", - "description": "Updated name of the pet", - "required": false, - "type": "string" - }, - { - "name": "status", - "in": "formData", - "description": "Updated status of the pet", - "required": false, - "type": "string" - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - }, - "delete": { - "tags": [ - "pet" - ], - "summary": "Deletes a pet", - "description": "", - "operationId": "deletePet", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "api_key", - "in": "header", - "required": false, - "type": "string" - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ] - } - }, - "/store/inventory": { - "get": { - "tags": [ - "store" - ], - "summary": "Returns pet inventories by status", - "description": "Returns a map of status codes to quantities", - "operationId": "getInventory", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, - "/store/order": { - "post": { - "tags": [ - "store" - ], - "summary": "Place an order for a pet", - "description": "", - "operationId": "placeOrder", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "order placed for purchasing the pet", - "required": true, - "schema": { - "$ref": "#/definitions/Order" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid Order" - } - } - } - }, - "/store/order/{orderId}": { - "get": { - "tags": [ - "store" - ], - "summary": "Find purchase order by ID", - "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", - "operationId": "getOrderById", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of pet that needs to be fetched", - "required": true, - "type": "integer", - "maximum": 10, - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - }, - "delete": { - "tags": [ - "store" - ], - "summary": "Delete purchase order by ID", - "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", - "operationId": "deleteOrder", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "type": "integer", - "minimum": 1, - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - } - }, - "/user/createWithList": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithListInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "get": { - "tags": [ - "user" - ], - "summary": "Get user by user name", - "description": "", - "operationId": "getUserByName", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be fetched. Use user1 for testing. ", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/User" - } - }, - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "put": { - "tags": [ - "user" - ], - "summary": "Updated user", - "description": "This can only be done by the logged in user.", - "operationId": "updateUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "name that need to be updated", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "Updated user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "400": { - "description": "Invalid user supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "delete": { - "tags": [ - "user" - ], - "summary": "Delete user", - "description": "This can only be done by the logged in user.", - "operationId": "deleteUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "type": "string" - } - ], - "responses": { - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - } - }, - "/user/login": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs user into the system", - "description": "", - "operationId": "loginUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": true, - "type": "string" - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "headers": { - "X-Expires-After": { - "type": "string", - "format": "date-time", - "description": "date in UTC when token expires" - }, - "X-Rate-Limit": { - "type": "integer", - "format": "int32", - "description": "calls per hour allowed by the user" - } - }, - "schema": { - "type": "string" - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "tags": [ - "user" - ], - "summary": "Logs out current logged in user session", - "description": "", - "operationId": "logoutUser", - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/createWithArray": { - "post": { - "tags": [ - "user" - ], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithArrayInput", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": true, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user": { - "post": { - "tags": [ - "user" - ], - "summary": "Create user", - "description": "This can only be done by the logged in user.", - "operationId": "createUser", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Created user object", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - } - }, - "securityDefinitions": { - "api_key": { - "type": "apiKey", - "name": "api_key", - "in": "header" - }, - "petstore_auth": { - "type": "oauth2", - "authorizationUrl": "https://petstore.swagger.io/oauth/authorize", - "flow": "implicit", - "scopes": { - "read:pets": "read your pets", - "write:pets": "modify pets in your account" - } - } - }, - "definitions": { - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Category" - } - }, - "Pet": { - "type": "object", - "required": [ - "name", - "photoUrls" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "category": { - "$ref": "#/definitions/Category" - }, - "name": { - "type": "string", - "example": "doggie" - }, - "photoUrls": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "type": "string", - "xml": { - "name": "photoUrl" - } - } - }, - "tags": { - "type": "array", - "xml": { - "wrapped": true - }, - "items": { - "xml": { - "name": "tag" - }, - "$ref": "#/definitions/Tag" - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": [ - "available", - "pending", - "sold" - ] - } - }, - "xml": { - "name": "Pet" - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Tag" - } - }, - "Order": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "petId": { - "type": "integer", - "format": "int64" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "shipDate": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Order Status", - "enum": [ - "placed", - "approved", - "delivered" - ] - }, - "complete": { - "type": "boolean" - } - }, - "xml": { - "name": "Order" - } - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "username": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "userStatus": { - "type": "integer", - "format": "int32", - "description": "User Status" - } - }, - "xml": { - "name": "User" - } - } - }, - "externalDocs": { - "description": "Find out more about Swagger", - "url": "http://swagger.io" - } -} \ No newline at end of file diff --git a/test/blackbox/docs/Swagger-2_0/slack-1_7.json b/test/blackbox/docs/Swagger-2_0/slack-1_7.json deleted file mode 100644 index 72c5dfb431..0000000000 --- a/test/blackbox/docs/Swagger-2_0/slack-1_7.json +++ /dev/null @@ -1,27441 +0,0 @@ -{ - "basePath": "/api", - "definitions": { - "blocks": { - "description": "This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.", - "items": { - "additionalProperties": true, - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "title": "Block Kit blocks", - "type": "array" - }, - "defs_app_id": { - "pattern": "^A[A-Z0-9]{1,}$", - "title": "App ID", - "type": "string" - }, - "defs_bot_id": { - "pattern": "^B[A-Z0-9]{8,}$", - "title": "Bot User ID", - "type": "string" - }, - "defs_channel": { - "pattern": "^[CGD][A-Z0-9]{8,}$", - "title": "Channel-like conversation ID", - "type": "string" - }, - "defs_channel_id": { - "pattern": "^[C][A-Z0-9]{2,}$", - "title": "Channel ID", - "type": "string" - }, - "defs_channel_name": { - "title": "Name of a channel", - "type": "string" - }, - "defs_comment_id": { - "pattern": "^Fc[A-Z0-9]{8,}$", - "title": "File Comment ID", - "type": "string" - }, - "defs_dm_id": { - "pattern": "^[D][A-Z0-9]{8,}$", - "title": "Direct Message Channel ID", - "type": "string" - }, - "defs_enterprise_id": { - "pattern": "^[E][A-Z0-9]{8,}$", - "title": "Enterprise ID", - "type": "string" - }, - "defs_enterprise_name": { - "title": "Name of the enterprise org", - "type": "string" - }, - "defs_enterprise_user_id": { - "pattern": "^[WU][A-Z0-9]{8,}$", - "title": "Enterprise User ID", - "type": "string" - }, - "defs_file_id": { - "pattern": "^[F][A-Z0-9]{8,}$", - "title": "File ID", - "type": "string" - }, - "defs_group_id": { - "pattern": "^[G][A-Z0-9]{8,}$", - "title": "Private Channel ID", - "type": "string" - }, - "defs_ok_false": { - "enum": [ - false - ], - "title": "default failure response", - "type": "boolean" - }, - "defs_ok_true": { - "enum": [ - true - ], - "title": "default success response", - "type": "boolean" - }, - "defs_optional_app_id": { - "pattern": "^(A[A-Z0-9]{1,})?$", - "title": "App ID or empty string", - "type": "string" - }, - "defs_pinned_info": { - "additionalProperties": false, - "title": "Info for a pinned item", - "type": "object" - }, - "defs_reminder_id": { - "pattern": "^Rm[A-Z0-9]{8,}$", - "title": "Reminder ID", - "type": "string" - }, - "defs_subteam_id": { - "pattern": "^S[A-Z0-9]{2,}$", - "title": "Subteam ID", - "type": "string" - }, - "defs_team": { - "pattern": "^[T][A-Z0-9]{2,}$", - "title": "Team ID", - "type": "string" - }, - "defs_topic_purpose_creator": { - "pattern": "^[UW][A-Z0-9]{8,}$|^$", - "title": "User ID or empty string, used for topic and purpose creation", - "type": "string" - }, - "defs_ts": { - "pattern": "^\\d{10}\\.\\d{6}$", - "title": "Timestamp in format 0123456789.012345", - "type": "string" - }, - "defs_user_id": { - "pattern": "^[UW][A-Z0-9]{2,}$", - "title": "User ID", - "type": "string" - }, - "defs_workspace_id": { - "pattern": "^[TE][A-Z0-9]{8,}$", - "title": "Team or Enterprise ID", - "type": "string" - }, - "objs_bot_profile": { - "additionalProperties": false, - "properties": { - "app_id": { - "$ref": "#/definitions/defs_app_id" - }, - "deleted": { - "type": "boolean" - }, - "icons": { - "additionalProperties": false, - "properties": { - "image_36": { - "format": "uri", - "type": "string" - }, - "image_48": { - "format": "uri", - "type": "string" - }, - "image_72": { - "format": "uri", - "type": "string" - } - }, - "required": [ - "image_36", - "image_48", - "image_72" - ], - "type": "object" - }, - "id": { - "$ref": "#/definitions/defs_bot_id" - }, - "name": { - "type": "string" - }, - "team_id": { - "$ref": "#/definitions/defs_team" - }, - "updated": { - "type": "integer" - } - }, - "required": [ - "id", - "deleted", - "name", - "updated", - "app_id", - "icons", - "team_id" - ], - "title": "Bot Profile Object", - "type": "object" - }, - "objs_channel": { - "additionalProperties": false, - "properties": { - "accepted_user": { - "$ref": "#/definitions/defs_user_id" - }, - "created": { - "type": "integer" - }, - "creator": { - "$ref": "#/definitions/defs_user_id" - }, - "id": { - "$ref": "#/definitions/defs_channel_id" - }, - "is_archived": { - "type": "boolean" - }, - "is_channel": { - "type": "boolean" - }, - "is_frozen": { - "type": "boolean" - }, - "is_general": { - "type": "boolean" - }, - "is_member": { - "type": "boolean" - }, - "is_moved": { - "type": "integer" - }, - "is_mpim": { - "type": "boolean" - }, - "is_non_threadable": { - "type": "boolean" - }, - "is_org_shared": { - "type": "boolean" - }, - "is_pending_ext_shared": { - "type": "boolean" - }, - "is_private": { - "type": "boolean" - }, - "is_read_only": { - "type": "boolean" - }, - "is_shared": { - "type": "boolean" - }, - "is_thread_only": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest": { - "items": [ - { - "$ref": "#/definitions/objs_message" - }, - { - "type": "null" - } - ] - }, - "members": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "name": { - "type": "string" - }, - "name_normalized": { - "type": "string" - }, - "num_members": { - "type": "integer" - }, - "pending_shared": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "previous_names": { - "items": { - "$ref": "#/definitions/defs_channel_name" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "priority": { - "type": "number" - }, - "purpose": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "topic": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "unlinked": { - "title": "Field to determine whether a channel has ever been shared/disconnected in the past", - "type": "integer" - }, - "unread_count": { - "type": "integer" - }, - "unread_count_display": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "created", - "creator", - "is_channel", - "is_org_shared", - "is_private", - "is_mpim", - "is_shared", - "name_normalized", - "members", - "topic", - "purpose" - ], - "title": "Channel Object", - "type": "object" - }, - "objs_comment": { - "additionalProperties": false, - "properties": { - "comment": { - "type": "string" - }, - "created": { - "type": "integer" - }, - "id": { - "$ref": "#/definitions/defs_comment_id" - }, - "is_intro": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "num_stars": { - "type": "integer" - }, - "pinned_info": { - "$ref": "#/definitions/defs_pinned_info" - }, - "pinned_to": { - "items": { - "$ref": "#/definitions/defs_channel" - }, - "type": "array" - }, - "reactions": { - "items": { - "$ref": "#/definitions/objs_reaction" - }, - "type": "array" - }, - "timestamp": { - "type": "integer" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "id", - "created", - "timestamp", - "user", - "is_intro", - "comment" - ], - "title": "File Comment Object", - "type": "object" - }, - "objs_comments": { - "items": {}, - "title": "file comments object", - "type": "array" - }, - "objs_conversation": { - "items": [ - { - "additionalProperties": false, - "properties": { - "accepted_user": { - "$ref": "#/definitions/defs_user_id" - }, - "connected_team_ids": { - "items": { - "$ref": "#/definitions/defs_workspace_id" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "conversation_host_id": { - "$ref": "#/definitions/defs_workspace_id" - }, - "created": { - "type": "integer" - }, - "creator": { - "$ref": "#/definitions/defs_user_id" - }, - "display_counts": { - "additionalProperties": false, - "properties": { - "display_counts": { - "type": "integer" - }, - "guest_counts": { - "type": "integer" - } - }, - "required": [ - "display_counts", - "guest_counts" - ], - "type": "object" - }, - "enterprise_id": { - "$ref": "#/definitions/defs_enterprise_id" - }, - "has_pins": { - "type": "boolean" - }, - "id": { - "$ref": "#/definitions/defs_channel" - }, - "internal_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "is_archived": { - "type": "boolean" - }, - "is_channel": { - "type": "boolean" - }, - "is_ext_shared": { - "type": "boolean" - }, - "is_frozen": { - "type": "boolean" - }, - "is_general": { - "type": "boolean" - }, - "is_global_shared": { - "type": "boolean" - }, - "is_group": { - "type": "boolean" - }, - "is_im": { - "type": "boolean" - }, - "is_member": { - "type": "boolean" - }, - "is_moved": { - "type": "integer" - }, - "is_mpim": { - "enum": [ - false - ], - "type": "boolean" - }, - "is_non_threadable": { - "type": "boolean" - }, - "is_open": { - "type": "boolean" - }, - "is_org_default": { - "type": "boolean" - }, - "is_org_mandatory": { - "type": "boolean" - }, - "is_org_shared": { - "type": "boolean" - }, - "is_pending_ext_shared": { - "type": "boolean" - }, - "is_private": { - "type": "boolean" - }, - "is_read_only": { - "type": "boolean" - }, - "is_shared": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "is_thread_only": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest": { - "items": [ - { - "$ref": "#/definitions/objs_message" - }, - { - "type": "null" - } - ] - }, - "members": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "name": { - "type": "string" - }, - "name_normalized": { - "type": "string" - }, - "num_members": { - "type": "integer" - }, - "parent_conversation": { - "items": [ - { - "$ref": "#/definitions/defs_channel" - }, - { - "type": "null" - } - ] - }, - "pending_connected_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "pending_shared": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "pin_count": { - "type": "integer" - }, - "previous_names": { - "items": { - "$ref": "#/definitions/defs_channel_name" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "priority": { - "type": "number" - }, - "purpose": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "shared_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "shares": { - "items": { - "additionalProperties": false, - "properties": { - "accepted_user": { - "$ref": "#/definitions/defs_user_id" - }, - "is_active": { - "type": "boolean" - }, - "team": { - "$ref": "#/definitions/objs_team" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "team", - "user", - "is_active" - ], - "type": "object" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "timezone_count": { - "type": "integer" - }, - "topic": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "unlinked": { - "title": "Field to determine whether a channel has ever been shared/disconnected in the past", - "type": "integer" - }, - "unread_count": { - "type": "integer" - }, - "unread_count_display": { - "type": "integer" - }, - "use_case": { - "type": "string" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "version": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "created", - "creator", - "is_archived", - "is_channel", - "is_general", - "is_mpim", - "is_group", - "is_org_shared", - "is_im", - "is_shared", - "is_private", - "name_normalized", - "topic", - "purpose" - ], - "title": "Conversation object", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "accepted_user": { - "$ref": "#/definitions/defs_user_id" - }, - "connected_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "conversation_host_id": { - "$ref": "#/definitions/defs_workspace_id" - }, - "created": { - "type": "integer" - }, - "creator": { - "$ref": "#/definitions/defs_user_id" - }, - "display_counts": { - "additionalProperties": false, - "properties": { - "display_counts": { - "type": "integer" - }, - "guest_counts": { - "type": "integer" - } - }, - "required": [ - "display_counts", - "guest_counts" - ], - "type": "object" - }, - "id": { - "$ref": "#/definitions/defs_channel" - }, - "internal_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "is_archived": { - "type": "boolean" - }, - "is_channel": { - "type": "boolean" - }, - "is_ext_shared": { - "type": "boolean" - }, - "is_frozen": { - "type": "boolean" - }, - "is_general": { - "type": "boolean" - }, - "is_group": { - "type": "boolean" - }, - "is_im": { - "type": "boolean" - }, - "is_member": { - "type": "boolean" - }, - "is_moved": { - "type": "integer" - }, - "is_mpim": { - "enum": [ - true - ], - "type": "boolean" - }, - "is_non_threadable": { - "type": "boolean" - }, - "is_open": { - "type": "boolean" - }, - "is_org_shared": { - "type": "boolean" - }, - "is_pending_ext_shared": { - "type": "boolean" - }, - "is_private": { - "type": "boolean" - }, - "is_read_only": { - "type": "boolean" - }, - "is_shared": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "is_thread_only": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest": { - "items": [ - { - "$ref": "#/definitions/objs_message" - }, - { - "type": "null" - } - ] - }, - "members": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "name": { - "type": "string" - }, - "name_normalized": { - "type": "string" - }, - "num_members": { - "type": "integer" - }, - "parent_conversation": { - "items": [ - { - "$ref": "#/definitions/defs_channel" - }, - { - "type": "null" - } - ] - }, - "pending_connected_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "pending_shared": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "pin_count": { - "type": "integer" - }, - "previous_names": { - "items": { - "$ref": "#/definitions/defs_channel_name" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "priority": { - "type": "number" - }, - "purpose": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "shared_team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "shares": { - "items": { - "additionalProperties": false, - "properties": { - "accepted_user": { - "$ref": "#/definitions/defs_user_id" - }, - "is_active": { - "type": "boolean" - }, - "team": { - "$ref": "#/definitions/objs_team" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "team", - "user", - "is_active" - ], - "type": "object" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "timezone_count": { - "type": "integer" - }, - "topic": { - "additionalProperties": false, - "properties": { - "creator": { - "$ref": "#/definitions/defs_topic_purpose_creator" - }, - "last_set": { - "type": "integer" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "creator", - "last_set" - ], - "type": "object" - }, - "unlinked": { - "title": "Field to determine whether a channel has ever been shared/disconnected in the past", - "type": "integer" - }, - "unread_count": { - "type": "integer" - }, - "unread_count_display": { - "type": "integer" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "version": { - "type": "integer" - } - }, - "required": [ - "id", - "name", - "created", - "creator", - "is_archived", - "is_channel", - "is_general", - "is_mpim", - "is_group", - "is_org_shared", - "is_im", - "is_shared", - "is_private", - "name_normalized", - "topic", - "purpose" - ], - "title": "Conversation MPIM Object", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "created": { - "type": "integer" - }, - "has_pins": { - "type": "boolean" - }, - "id": { - "$ref": "#/definitions/defs_dm_id" - }, - "is_archived": { - "type": "boolean" - }, - "is_ext_shared": { - "type": "boolean" - }, - "is_frozen": { - "type": "boolean" - }, - "is_im": { - "type": "boolean" - }, - "is_open": { - "type": "boolean" - }, - "is_org_shared": { - "type": "boolean" - }, - "is_shared": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "is_user_deleted": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest": { - "items": [ - { - "$ref": "#/definitions/objs_message" - }, - { - "type": "null" - } - ] - }, - "parent_conversation": { - "items": [ - { - "$ref": "#/definitions/defs_channel" - }, - { - "type": "null" - } - ] - }, - "pin_count": { - "type": "integer" - }, - "priority": { - "type": "number" - }, - "shares": { - "items": { - "additionalProperties": false, - "properties": { - "date_create": { - "type": "integer" - }, - "id": { - "$ref": "#/definitions/defs_team" - }, - "is_active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "team": { - "$ref": "#/definitions/objs_team" - } - }, - "required": [ - "id", - "name", - "team", - "date_create", - "is_active" - ], - "type": "object" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "unread_count": { - "type": "integer" - }, - "unread_count_display": { - "type": "integer" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "version": { - "type": "integer" - } - }, - "required": [ - "id", - "created", - "is_im", - "is_org_shared", - "user", - "priority" - ], - "title": "Conversation IM Channel Object from conversations.* methods", - "type": "object" - } - ] - }, - "objs_enterprise_user": { - "additionalProperties": false, - "properties": { - "enterprise_id": { - "$ref": "#/definitions/defs_enterprise_id" - }, - "enterprise_name": { - "$ref": "#/definitions/defs_enterprise_name" - }, - "id": { - "$ref": "#/definitions/defs_enterprise_user_id" - }, - "is_admin": { - "type": "boolean" - }, - "is_owner": { - "type": "boolean" - }, - "teams": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "id", - "enterprise_id", - "enterprise_name", - "is_admin", - "is_owner", - "teams" - ], - "type": "object" - }, - "objs_external_org_migrations": { - "properties": { - "current": { - "items": { - "properties": { - "date_started": { - "type": "integer" - }, - "team_id": { - "type": "string" - } - }, - "required": [ - "team_id", - "date_started" - ], - "type": "object" - }, - "type": "array" - }, - "date_updated": { - "type": "integer" - } - }, - "required": [ - "date_updated", - "current" - ], - "title": "External Org Migrations", - "type": "object" - }, - "objs_file": { - "additionalProperties": false, - "properties": { - "channels": { - "items": { - "$ref": "#/definitions/defs_channel_id" - }, - "type": "array", - "uniqueItems": true - }, - "comments_count": { - "type": "integer" - }, - "created": { - "type": "integer" - }, - "date_delete": { - "type": "integer" - }, - "display_as_bot": { - "type": "boolean" - }, - "editable": { - "type": "boolean" - }, - "editor": { - "$ref": "#/definitions/defs_user_id" - }, - "external_id": { - "type": "string" - }, - "external_type": { - "type": "string" - }, - "external_url": { - "format": "uri", - "type": "string" - }, - "filetype": { - "type": "string" - }, - "groups": { - "items": { - "$ref": "#/definitions/defs_group_id" - }, - "type": "array", - "uniqueItems": true - }, - "has_rich_preview": { - "type": "boolean" - }, - "id": { - "$ref": "#/definitions/defs_file_id" - }, - "image_exif_rotation": { - "type": "integer" - }, - "ims": { - "items": { - "$ref": "#/definitions/defs_dm_id" - }, - "type": "array", - "uniqueItems": true - }, - "is_external": { - "type": "boolean" - }, - "is_public": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "is_tombstoned": { - "type": "boolean" - }, - "last_editor": { - "$ref": "#/definitions/defs_user_id" - }, - "mimetype": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "name": { - "type": "string" - }, - "non_owner_editable": { - "type": "boolean" - }, - "num_stars": { - "type": "integer" - }, - "original_h": { - "type": "integer" - }, - "original_w": { - "type": "integer" - }, - "permalink": { - "format": "uri", - "type": "string" - }, - "permalink_public": { - "format": "uri", - "type": "string" - }, - "pinned_info": { - "$ref": "#/definitions/defs_pinned_info" - }, - "pinned_to": { - "items": { - "$ref": "#/definitions/defs_channel" - }, - "type": "array" - }, - "pretty_type": { - "type": "string" - }, - "preview": { - "type": "string" - }, - "public_url_shared": { - "type": "boolean" - }, - "reactions": { - "items": { - "$ref": "#/definitions/objs_reaction" - }, - "type": "array" - }, - "shares": { - "additionalProperties": false, - "properties": { - "private": { - "additionalProperties": false - }, - "public": { - "additionalProperties": false - } - }, - "type": "object" - }, - "size": { - "type": "integer" - }, - "source_team": { - "$ref": "#/definitions/defs_team" - }, - "state": { - "type": "string" - }, - "thumb_1024": { - "format": "uri", - "type": "string" - }, - "thumb_1024_h": { - "type": "integer" - }, - "thumb_1024_w": { - "type": "integer" - }, - "thumb_160": { - "format": "uri", - "type": "string" - }, - "thumb_360": { - "format": "uri", - "type": "string" - }, - "thumb_360_h": { - "type": "integer" - }, - "thumb_360_w": { - "type": "integer" - }, - "thumb_480": { - "format": "uri", - "type": "string" - }, - "thumb_480_h": { - "type": "integer" - }, - "thumb_480_w": { - "type": "integer" - }, - "thumb_64": { - "format": "uri", - "type": "string" - }, - "thumb_720": { - "format": "uri", - "type": "string" - }, - "thumb_720_h": { - "type": "integer" - }, - "thumb_720_w": { - "type": "integer" - }, - "thumb_80": { - "format": "uri", - "type": "string" - }, - "thumb_800": { - "format": "uri", - "type": "string" - }, - "thumb_800_h": { - "type": "integer" - }, - "thumb_800_w": { - "type": "integer" - }, - "thumb_960": { - "format": "uri", - "type": "string" - }, - "thumb_960_h": { - "type": "integer" - }, - "thumb_960_w": { - "type": "integer" - }, - "thumb_tiny": { - "type": "string" - }, - "timestamp": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "updated": { - "type": "integer" - }, - "url_private": { - "format": "uri", - "type": "string" - }, - "url_private_download": { - "format": "uri", - "type": "string" - }, - "user": { - "type": "string" - }, - "user_team": { - "$ref": "#/definitions/defs_team" - }, - "username": { - "type": "string" - } - }, - "title": "file object", - "type": "object" - }, - "objs_icon": { - "properties": { - "image_102": { - "type": "string" - }, - "image_132": { - "type": "string" - }, - "image_230": { - "type": "string" - }, - "image_34": { - "type": "string" - }, - "image_44": { - "type": "string" - }, - "image_68": { - "type": "string" - }, - "image_88": { - "type": "string" - }, - "image_default": { - "type": "boolean" - } - }, - "type": "object" - }, - "objs_message": { - "additionalProperties": false, - "properties": { - "attachments": { - "items": { - "additionalProperties": false, - "properties": { - "fallback": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "image_bytes": { - "type": "integer" - }, - "image_height": { - "type": "integer" - }, - "image_url": { - "type": "string" - }, - "image_width": { - "type": "integer" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "blocks": { - "$ref": "#/definitions/blocks" - }, - "bot_id": { - "items": [ - { - "$ref": "#/definitions/defs_bot_id" - }, - { - "title": "Nil bot_id set when display_as_bot is false", - "type": "null" - } - ] - }, - "bot_profile": { - "$ref": "#/definitions/objs_bot_profile" - }, - "client_msg_id": { - "type": "string" - }, - "comment": { - "$ref": "#/definitions/objs_comment" - }, - "display_as_bot": { - "type": "boolean" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "files": { - "items": { - "$ref": "#/definitions/objs_file" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "icons": { - "additionalProperties": false, - "properties": { - "emoji": { - "type": "string" - }, - "image_64": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "inviter": { - "$ref": "#/definitions/defs_user_id" - }, - "is_delayed_message": { - "type": "boolean" - }, - "is_intro": { - "type": "boolean" - }, - "is_starred": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest_reply": { - "$ref": "#/definitions/defs_ts" - }, - "name": { - "type": "string" - }, - "old_name": { - "type": "string" - }, - "parent_user_id": { - "$ref": "#/definitions/defs_user_id" - }, - "permalink": { - "format": "uri", - "type": "string" - }, - "pinned_to": { - "items": { - "$ref": "#/definitions/defs_channel" - }, - "type": "array" - }, - "purpose": { - "type": "string" - }, - "reactions": { - "items": { - "$ref": "#/definitions/objs_reaction" - }, - "type": "array" - }, - "reply_count": { - "type": "integer" - }, - "reply_users": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "reply_users_count": { - "type": "integer" - }, - "source_team": { - "$ref": "#/definitions/defs_workspace_id" - }, - "subscribed": { - "type": "boolean" - }, - "subtype": { - "type": "string" - }, - "team": { - "$ref": "#/definitions/defs_workspace_id" - }, - "text": { - "type": "string" - }, - "thread_ts": { - "$ref": "#/definitions/defs_ts" - }, - "topic": { - "type": "string" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - }, - "type": { - "type": "string" - }, - "unread_count": { - "type": "integer" - }, - "upload": { - "type": "boolean" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "user_profile": { - "$ref": "#/definitions/objs_user_profile_short" - }, - "user_team": { - "$ref": "#/definitions/defs_workspace_id" - }, - "username": { - "type": "string" - } - }, - "required": [ - "text", - "type", - "ts" - ], - "title": "Message object", - "type": "object" - }, - "objs_paging": { - "additionalProperties": false, - "properties": { - "count": { - "type": "integer" - }, - "page": { - "type": "integer" - }, - "pages": { - "type": "integer" - }, - "per_page": { - "type": "integer" - }, - "spill": { - "type": "integer" - }, - "total": { - "type": "integer" - } - }, - "required": [ - "page", - "total" - ], - "title": "paging object", - "type": "object" - }, - "objs_primary_owner": { - "properties": { - "email": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "id", - "email" - ], - "type": "object" - }, - "objs_reaction": { - "additionalProperties": true, - "properties": { - "count": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "users": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "type": "array" - } - }, - "required": [ - "name", - "users", - "count" - ], - "title": "Reaction object", - "type": "object" - }, - "objs_reminder": { - "additionalProperties": false, - "properties": { - "complete_ts": { - "type": "integer" - }, - "creator": { - "$ref": "#/definitions/defs_user_id" - }, - "id": { - "$ref": "#/definitions/defs_reminder_id" - }, - "recurring": { - "type": "boolean" - }, - "text": { - "type": "string" - }, - "time": { - "type": "integer" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "id", - "creator", - "user", - "text", - "recurring" - ], - "type": "object" - }, - "objs_resources": { - "additionalProperties": false, - "properties": { - "excluded_ids": { - "items": { - "items": [ - { - "$ref": "#/definitions/defs_channel" - }, - { - "$ref": "#/definitions/defs_team" - } - ] - }, - "type": "array" - }, - "ids": { - "items": { - "items": [ - { - "$ref": "#/definitions/defs_channel" - }, - { - "$ref": "#/definitions/defs_team" - } - ] - }, - "type": "array" - }, - "wildcard": { - "type": "boolean" - } - }, - "required": [ - "ids" - ], - "title": "resources in info from apps.permissions.info", - "type": "object" - }, - "objs_response_metadata": { - "items": [ - { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "title": "new paging style", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "messages": { - "items": { - "type": "string" - }, - "type": "array" - }, - "warnings": { - "items": { - "enum": [ - "method_deprecated" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "messages", - "warnings" - ], - "title": "deprecation_warning", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "messages": { - "items": { - "type": "string" - }, - "type": "array" - }, - "next_cursor": { - "type": "string" - }, - "warnings": { - "items": { - "enum": [ - "method_deprecated" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "messages", - "warnings", - "next_cursor" - ], - "title": "deprecation_warning and paging style together", - "type": "object" - } - ] - }, - "objs_scopes": { - "items": { - "title": "Named OAuth scopes", - "type": "string", - "x-examples": [ - "chat:write", - "im:history", - "im:read" - ] - }, - "type": "array" - }, - "objs_subteam": { - "additionalProperties": false, - "properties": { - "auto_provision": { - "type": "boolean" - }, - "auto_type": { - "items": [ - { - "type": "null" - }, - { - "enum": [ - "owner", - "admin" - ], - "type": "string" - } - ] - }, - "channel_count": { - "type": "integer" - }, - "created_by": { - "$ref": "#/definitions/defs_user_id" - }, - "date_create": { - "type": "integer" - }, - "date_delete": { - "type": "integer" - }, - "date_update": { - "type": "integer" - }, - "deleted_by": { - "items": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/defs_user_id" - } - ] - }, - "description": { - "type": "string" - }, - "enterprise_subteam_id": { - "type": "string" - }, - "handle": { - "type": "string" - }, - "id": { - "$ref": "#/definitions/defs_subteam_id" - }, - "is_external": { - "type": "boolean" - }, - "is_subteam": { - "type": "boolean" - }, - "is_usergroup": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "prefs": { - "additionalProperties": false, - "properties": { - "channels": { - "items": { - "$ref": "#/definitions/defs_channel_id" - }, - "type": "array" - }, - "groups": { - "items": { - "$ref": "#/definitions/defs_group_id" - }, - "type": "array" - } - }, - "required": [ - "channels", - "groups" - ], - "type": "object" - }, - "team_id": { - "$ref": "#/definitions/defs_team" - }, - "updated_by": { - "$ref": "#/definitions/defs_user_id" - }, - "user_count": { - "type": "integer" - }, - "users": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "type": "array" - } - }, - "required": [ - "id", - "team_id", - "is_usergroup", - "is_subteam", - "name", - "description", - "handle", - "is_external", - "date_create", - "date_update", - "date_delete", - "auto_type", - "auto_provision", - "enterprise_subteam_id", - "created_by", - "updated_by", - "deleted_by", - "prefs" - ], - "title": "Subteam/Usergroup Object", - "type": "object" - }, - "objs_team": { - "additionalProperties": false, - "properties": { - "archived": { - "type": "boolean" - }, - "avatar_base_url": { - "format": "uri", - "type": "string" - }, - "created": { - "type": "integer" - }, - "date_create": { - "type": "integer" - }, - "deleted": { - "type": "boolean" - }, - "description": { - "type": [ - "null", - "string" - ] - }, - "discoverable": { - "items": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "domain": { - "type": "string" - }, - "email_domain": { - "type": "string" - }, - "enterprise_id": { - "$ref": "#/definitions/defs_enterprise_id" - }, - "enterprise_name": { - "$ref": "#/definitions/defs_enterprise_name" - }, - "external_org_migrations": { - "$ref": "#/definitions/objs_external_org_migrations" - }, - "has_compliance_export": { - "type": "boolean" - }, - "icon": { - "$ref": "#/definitions/objs_icon" - }, - "id": { - "$ref": "#/definitions/defs_workspace_id" - }, - "is_assigned": { - "type": "boolean" - }, - "is_enterprise": { - "type": "integer" - }, - "is_over_storage_limit": { - "type": "boolean" - }, - "limit_ts": { - "type": "integer" - }, - "locale": { - "type": "string" - }, - "messages_count": { - "type": "integer" - }, - "msg_edit_window_mins": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "over_integrations_limit": { - "type": "boolean" - }, - "over_storage_limit": { - "type": "boolean" - }, - "pay_prod_cur": { - "type": "string" - }, - "plan": { - "enum": [ - "", - "std", - "plus", - "compliance", - "enterprise" - ], - "type": "string" - }, - "primary_owner": { - "$ref": "#/definitions/objs_primary_owner" - }, - "sso_provider": { - "properties": { - "label": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "id", - "name", - "domain", - "email_domain", - "icon" - ], - "title": "Team Object", - "type": "object" - }, - "objs_team_profile_field": { - "additionalProperties": false, - "properties": { - "field_name": { - "type": [ - "null", - "string" - ] - }, - "hint": { - "type": "string" - }, - "id": { - "pattern": "^X[a-zA-Z0-9]{9,}$", - "type": "string" - }, - "is_hidden": { - "type": "boolean" - }, - "label": { - "type": "string" - }, - "options": { - "items": [ - { - "type": "null" - }, - { - "$ref": "#/definitions/objs_team_profile_field_option" - } - ] - }, - "ordering": { - "type": "number" - }, - "possible_values": { - "items": { - "type": "string" - }, - "type": [ - "null", - "array" - ] - }, - "type": { - "enum": [ - "text", - "date", - "link", - "mailto", - "options_list", - "user" - ], - "type": "string" - } - }, - "required": [ - "id", - "ordering", - "label", - "hint", - "type" - ], - "type": "object" - }, - "objs_team_profile_field_option": { - "additionalProperties": false, - "properties": { - "is_custom": { - "type": [ - "null", - "boolean" - ] - }, - "is_multiple_entry": { - "type": [ - "null", - "boolean" - ] - }, - "is_protected": { - "type": [ - "null", - "boolean" - ] - }, - "is_scim": { - "type": [ - "null", - "boolean" - ] - } - }, - "type": "object" - }, - "objs_user": { - "items": [ - { - "additionalProperties": false, - "description": "user object for non enterprise type", - "properties": { - "color": { - "pattern": "^[a-fA-F0-9]{6}$", - "type": "string" - }, - "deleted": { - "type": "boolean" - }, - "enterprise_user": { - "$ref": "#/definitions/objs_enterprise_user" - }, - "has_2fa": { - "type": "boolean" - }, - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "is_admin": { - "type": "boolean" - }, - "is_app_user": { - "type": "boolean" - }, - "is_bot": { - "type": "boolean" - }, - "is_external": { - "type": "boolean" - }, - "is_forgotten": { - "type": "boolean" - }, - "is_invited_user": { - "type": "boolean" - }, - "is_owner": { - "type": "boolean" - }, - "is_primary_owner": { - "type": "boolean" - }, - "is_restricted": { - "type": "boolean" - }, - "is_stranger": { - "type": "boolean" - }, - "is_ultra_restricted": { - "type": "boolean" - }, - "locale": { - "type": "string" - }, - "name": { - "type": "string" - }, - "presence": { - "type": "string" - }, - "profile": { - "$ref": "#/definitions/objs_user_profile" - }, - "real_name": { - "type": "string" - }, - "team": { - "$ref": "#/definitions/defs_workspace_id" - }, - "team_id": { - "$ref": "#/definitions/defs_workspace_id" - }, - "team_profile": { - "additionalProperties": false, - "properties": { - "fields": { - "items": { - "$ref": "#/definitions/objs_team_profile_field" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fields" - ], - "type": "object" - }, - "two_factor_type": { - "type": "string" - }, - "tz": { - "items": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "tz_label": { - "type": "string" - }, - "tz_offset": { - "type": "number" - }, - "updated": { - "type": "number" - } - }, - "required": [ - "id", - "name", - "profile", - "is_bot", - "updated", - "is_app_user" - ], - "type": "object" - }, - { - "additionalProperties": false, - "description": "enterprise user", - "properties": { - "color": { - "description": "refercing to bug: https://jira.tinyspeck.com/browse/EVALUE-1559", - "pattern": "^([a-fA-F0-9]{6})?$", - "type": "string" - }, - "deleted": { - "type": "boolean" - }, - "enterprise_user": { - "$ref": "#/definitions/objs_enterprise_user" - }, - "has_2fa": { - "type": "boolean" - }, - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "is_admin": { - "type": "boolean" - }, - "is_app_user": { - "type": "boolean" - }, - "is_bot": { - "type": "boolean" - }, - "is_external": { - "type": "boolean" - }, - "is_forgotten": { - "type": "boolean" - }, - "is_owner": { - "type": "boolean" - }, - "is_primary_owner": { - "type": "boolean" - }, - "is_restricted": { - "type": "boolean" - }, - "is_stranger": { - "type": "boolean" - }, - "is_ultra_restricted": { - "type": "boolean" - }, - "locale": { - "type": "string" - }, - "name": { - "type": "string" - }, - "presence": { - "type": "string" - }, - "profile": { - "$ref": "#/definitions/objs_user_profile" - }, - "real_name": { - "type": "string" - }, - "team_id": { - "$ref": "#/definitions/defs_workspace_id" - }, - "team_profile": { - "additionalProperties": false, - "properties": { - "fields": { - "items": { - "$ref": "#/definitions/objs_team_profile_field" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fields" - ], - "type": "object" - }, - "teams": { - "items": { - "$ref": "#/definitions/defs_workspace_id" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "two_factor_type": { - "type": "string" - }, - "tz": { - "items": [ - { - "type": "null" - }, - { - "type": "string" - } - ] - }, - "tz_label": { - "type": "string" - }, - "tz_offset": { - "type": "number" - }, - "updated": { - "type": "number" - } - }, - "required": [ - "id", - "name", - "profile", - "is_bot", - "updated", - "is_app_user" - ], - "type": "object" - } - ] - }, - "objs_user_profile": { - "additionalProperties": false, - "properties": { - "always_active": { - "type": "boolean" - }, - "api_app_id": { - "$ref": "#/definitions/defs_optional_app_id" - }, - "avatar_hash": { - "type": "string" - }, - "bot_id": { - "$ref": "#/definitions/defs_bot_id" - }, - "display_name": { - "type": "string" - }, - "display_name_normalized": { - "type": "string" - }, - "email": { - "format": "email", - "type": [ - "null", - "string" - ] - }, - "fields": { - "items": { - "type": "object" - }, - "type": [ - "object", - "null", - "array" - ] - }, - "first_name": { - "type": [ - "null", - "string" - ] - }, - "guest_expiration_ts": { - "type": [ - "null", - "integer" - ] - }, - "guest_invited_by": { - "type": [ - "null", - "string" - ] - }, - "image_1024": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_192": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_24": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_32": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_48": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_512": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_72": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "image_original": { - "format": "uri", - "type": [ - "null", - "string" - ] - }, - "is_app_user": { - "type": "boolean" - }, - "is_custom_image": { - "type": "boolean" - }, - "is_restricted": { - "type": [ - "null", - "boolean" - ] - }, - "is_ultra_restricted": { - "type": [ - "null", - "boolean" - ] - }, - "last_avatar_image_hash": { - "type": "string" - }, - "last_name": { - "type": [ - "null", - "string" - ] - }, - "memberships_count": { - "type": "integer" - }, - "name": { - "type": [ - "null", - "string" - ] - }, - "phone": { - "type": "string" - }, - "pronouns": { - "type": "string" - }, - "real_name": { - "type": "string" - }, - "real_name_normalized": { - "type": "string" - }, - "skype": { - "type": "string" - }, - "status_default_emoji": { - "type": "string" - }, - "status_default_text": { - "type": "string" - }, - "status_default_text_canonical": { - "type": [ - "null", - "string" - ] - }, - "status_emoji": { - "type": "string" - }, - "status_expiration": { - "type": "integer" - }, - "status_text": { - "type": "string" - }, - "status_text_canonical": { - "type": [ - "null", - "string" - ] - }, - "team": { - "$ref": "#/definitions/defs_workspace_id" - }, - "title": { - "type": "string" - }, - "updated": { - "type": "integer" - }, - "user_id": { - "type": "string" - }, - "username": { - "type": [ - "null", - "string" - ] - } - }, - "required": [ - "real_name", - "display_name", - "avatar_hash", - "real_name_normalized", - "display_name_normalized", - "title", - "phone", - "skype", - "status_text", - "status_emoji", - "fields" - ], - "title": "User profile object", - "type": "object" - }, - "objs_user_profile_short": { - "additionalProperties": false, - "properties": { - "avatar_hash": { - "type": "string" - }, - "display_name": { - "type": "string" - }, - "display_name_normalized": { - "type": "string" - }, - "first_name": { - "type": [ - "string", - "null" - ] - }, - "image_72": { - "format": "uri", - "type": "string" - }, - "is_restricted": { - "type": "boolean" - }, - "is_ultra_restricted": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "real_name": { - "type": "string" - }, - "real_name_normalized": { - "type": "string" - }, - "team": { - "$ref": "#/definitions/defs_workspace_id" - } - }, - "required": [ - "avatar_hash", - "image_72", - "first_name", - "real_name", - "display_name", - "team", - "name", - "is_restricted", - "is_ultra_restricted" - ], - "type": "object" - } - }, - "externalDocs": { - "description": "Learn more about the Slack Web API", - "url": "https://api.slack.com/web" - }, - "host": "slack.com", - "info": { - "contact": { - "name": "Slack developer relations", - "url": "https://api.slack.com/support" - }, - "description": "One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.", - "title": "Slack Web API", - "version": "1.7.0" - }, - "paths": { - "/admin.apps.approve": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Approve an app for installation on a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.approve" - }, - "operationId": "admin_apps_approve", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.apps:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The id of the app to approve.", - "in": "formData", - "name": "app_id", - "type": "string" - }, - { - "description": "The id of the request to approve.", - "in": "formData", - "name": "request_id", - "type": "string" - }, - { - "in": "formData", - "name": "team_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.apps:write" - ] - } - ], - "tags": [ - "admin.apps", - "admin" - ] - } - }, - "/admin.apps.approved.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List approved apps for an org or workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.approved.list" - }, - "operationId": "admin_apps_approved_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.apps:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "in": "query", - "name": "enterprise_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "approved_apps": [ - { - "app": { - "additional_info": "", - "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app", - "app_homepage_url": "https://www.slack.com", - "description": "test app", - "help_url": "https://www.slack.com", - "icons": { - "image_1024": "https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png", - "image_128": "https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png", - "image_192": "https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png", - "image_32": "https://302674312496446w_2bd4ea1ad1f89a23c242_32.png", - "image_36": "https://302674312496446w_2bd4ea1ad1f89a23c242_36.png", - "image_48": "https://302674312496446w_2bd4ea1ad1f89a23c242_48.png", - "image_512": "https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png", - "image_64": "https://302674312496446w_2bd4ea1ad1f89a23c242_64.png", - "image_72": "https://302674312496446w_2bd4ea1ad1f89a23c242_72.png", - "image_96": "https://302674312496446w_2bd4ea1ad1f89a23c242_96.png", - "image_original": "https://302674446w12496_2bd4ea1ad1f89a23c242_original.png" - }, - "id": "A0W7UKG8E", - "is_app_directory_approved": false, - "is_internal": false, - "name": "My Test App", - "privacy_policy_url": "https://www.slack.com" - }, - "date_updated": 1574296707, - "last_resolved_by": { - "actor_id": "W0G82F4FD", - "actor_type": "user" - }, - "scopes": [ - { - "description": "Add the ability for people to direct message or mention @my_test_app", - "is_sensitive": true, - "name": "bot", - "token_type": "bot" - } - ] - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.apps:read" - ] - } - ], - "tags": [ - "admin.apps.approved", - "admin" - ] - } - }, - "/admin.apps.requests.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List app requests for a team/workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.requests.list" - }, - "operationId": "admin_apps_requests_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.apps:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "app_requests": [ - { - "app": { - "additional_info": "", - "app_directory_url": "https://acmecorp.slack.com/apps/A061BL8RQ0-test-app", - "app_homepage_url": "", - "description": "", - "help_url": "", - "icons": { - "image_1024": "/cdn/15258203/img/testapp/service_1024.png", - "image_128": "/cdn/157258203/img/testapp/service_128.png", - "image_192": "/cdn/157258203/img/testapp/service_192.png", - "image_32": "/cdn/157658203/img/testapp/service_32.png", - "image_36": "/cdn/157658203/img/testapp/service_36.png", - "image_48": "/cdn/157658203/img/testapp/service_48.png", - "image_512": "/cdn/15758203/img/testapp/service_512.png", - "image_64": "/cdn/157658203/img/testapp/service_64.png", - "image_72": "/cdn/157658203/img/testapp/service_72.png", - "image_96": "/cdn/157658203/img/testapp/service_96.png" - }, - "id": "A061BL8RQ0", - "is_app_directory_approved": true, - "is_internal": false, - "name": "Test App", - "privacy_policy_url": "https://testapp.com/privacy" - }, - "date_created": 1578956327, - "id": "Ar0XJGFLMLS", - "message": "test test again", - "previous_resolution": null, - "scopes": [ - { - "description": "Post messages to specific channels in Slack", - "is_sensitive": false, - "name": "incoming-webhook", - "token_type": "user" - } - ], - "team": { - "domain": "acmecorp", - "id": "T0M94LNUCR", - "name": "Acme Corp" - }, - "user": { - "email": "janedoe@example.com", - "id": "W08RA9G5HR", - "name": "Jane Doe" - } - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "missing_scope", - "needed": "admin.apps:read", - "ok": false, - "provided": "read,client,admin,identify,post,apps" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.apps:read" - ] - } - ], - "tags": [ - "admin.apps.requests", - "admin" - ] - } - }, - "/admin.apps.restrict": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Restrict an app for installation on a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.restrict" - }, - "operationId": "admin_apps_restrict", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.apps:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The id of the app to restrict.", - "in": "formData", - "name": "app_id", - "type": "string" - }, - { - "description": "The id of the request to restrict.", - "in": "formData", - "name": "request_id", - "type": "string" - }, - { - "in": "formData", - "name": "team_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.apps:write" - ] - } - ], - "tags": [ - "admin.apps", - "admin" - ] - } - }, - "/admin.apps.restricted.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List restricted apps for an org or workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.restricted.list" - }, - "operationId": "admin_apps_restricted_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.apps:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "in": "query", - "name": "enterprise_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "response_metadata": { - "next_cursor": "" - }, - "restricted_apps": [ - { - "app": { - "additional_info": "", - "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app", - "app_homepage_url": "https://example.com", - "description": "A fun test app for Slack", - "help_url": "https://example.com", - "icons": { - "image_1024": "https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png", - "image_128": "https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png", - "image_192": "https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png", - "image_32": "https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png", - "image_36": "https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png", - "image_48": "https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png", - "image_512": "https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png", - "image_64": "https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png", - "image_72": "https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png", - "image_96": "https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png", - "image_original": "https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png" - }, - "id": "A0FDLP8M2L", - "is_app_directory_approved": true, - "is_internal": false, - "name": "My Test App", - "privacy_policy_url": "https://example.com" - }, - "date_updated": 1574296721, - "last_resolved_by": { - "actor_id": "W0G82LMFD", - "actor_type": "user" - }, - "scopes": [ - { - "description": "Upload, edit, and delete files on the user\u201fs behalf", - "is_sensitive": true, - "name": "files:write:user", - "token_type": "user" - } - ] - } - ] - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.apps:read" - ] - } - ], - "tags": [ - "admin.apps.restricted", - "admin" - ] - } - }, - "/admin.conversations.archive": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Archive a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.archive" - }, - "operationId": "admin_conversations_archive", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to archive.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.archive", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.archive schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.archive", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "channel_not_found", - "channel_type_not_supported", - "default_org_wide_channel", - "already_archived", - "cant_archive_general", - "restricted_action", - "could_not_archive_channel" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.archive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.convertToPrivate": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Convert a public channel to a private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.convertToPrivate" - }, - "operationId": "admin_conversations_convertToPrivate", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to convert to private.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.convertToPrivate", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.convertToPrivate schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.convertToPrivate", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "restricted_action", - "name_taken", - "channel_not_found", - "channel_type_not_supported", - "default_org_wide_channel", - "method_not_supported_for_channel_type", - "could_not_convert_channel", - "external_channel_migrating" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.convertToPrivate error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.create": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Create a public or private channel-based conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.create" - }, - "operationId": "admin_conversations_create", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Name of the public or private channel to create.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Description of the public or private channel to create.", - "in": "formData", - "name": "description", - "type": "string" - }, - { - "description": "When `true`, creates a private channel instead of a public channel", - "in": "formData", - "name": "is_private", - "required": true, - "type": "boolean" - }, - { - "description": "When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel", - "in": "formData", - "name": "org_wide", - "type": "boolean" - }, - { - "description": "The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.", - "in": "formData", - "name": "team_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel_id": "C12345", - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.create", - "properties": { - "channel_id": { - "$ref": "#/definitions/defs_channel_id" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.create schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.create", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "name_taken", - "restricted_action", - "team_not_found", - "invalid_team", - "invalid_name", - "could_not_create_channel", - "team_id_or_org_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.create error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.delete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Delete a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.delete" - }, - "operationId": "admin_conversations_delete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to delete.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.delete", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.delete schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.delete", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "not_an_admin", - "channel_not_found", - "channel_type_not_supported", - "default_org_wide_channel", - "restricted_action", - "could_not_delete_channel", - "missing_scope" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.delete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.disconnectShared": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Disconnect a connected channel from one or more workspaces.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.disconnectShared" - }, - "operationId": "admin_conversations_disconnectShared", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to be disconnected from some workspaces.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "description": "The team to be removed from the channel. Currently only a single team id can be specified.", - "in": "formData", - "name": "leaving_team_ids", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.disconnectShared", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.rename schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.disconnectShared", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "not_an_admin", - "not_an_enterprise", - "channel_not_found", - "not_supported", - "team_not_found", - "restricted_action", - "missing_scope", - "leaving_team_not_in_channel", - "no_teams_to_disconnect", - "leaving_team_required", - "cannot_kick_team", - "cannot_kick_home_team" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.disconnectShared error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.ekm.listOriginalConnectedChannelInfo": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all disconnected channels\u2014i.e., channels that were once connected to other workspaces and then disconnected\u2014and the corresponding original channel IDs for key revocation with EKM.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo" - }, - "operationId": "admin_conversations_ekm_listOriginalConnectedChannelInfo", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A comma-separated list of channels to filter to.", - "in": "query", - "name": "channel_ids", - "type": "string" - }, - { - "description": "A comma-separated list of the workspaces to which the channels you would like returned belong.", - "in": "query", - "name": "team_ids", - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channels": [ - { - "id": "string", - "internal_team_ids": "array", - "original_connected_channel_id": "string", - "original_connected_host_id": "string" - } - ], - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:read" - ] - } - ], - "tags": [ - "admin.conversations.ekm", - "admin" - ] - } - }, - "/admin.conversations.getConversationPrefs": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Get conversation preferences for a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.getConversationPrefs" - }, - "operationId": "admin_conversations_getConversationPrefs", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to get preferences for.", - "in": "query", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.getConversationPrefs", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "prefs": { - "properties": { - "can_thread": { - "properties": { - "type": { - "items": { - "type": "string" - }, - "type": "array" - }, - "user": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "who_can_post": { - "properties": { - "type": { - "items": { - "type": "string" - }, - "type": "array" - }, - "user": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.getConversationPrefs schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.getConversationPrefs", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "not_an_admin", - "not_an_enterprise", - "restricted_action", - "missing_scope", - "channel_not_found", - "channel_type_not_supported", - "could_not_get_conversation_prefs" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:read" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.getTeams": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Get all the workspaces a given public or private channel is connected to within this Enterprise org.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.getTeams" - }, - "operationId": "admin_conversations_getTeams", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to determine connected workspaces within the organization for.", - "in": "query", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "teams": [ - "T1234", - "T5678" - ] - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.getTeams", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - }, - "team_ids": { - "items": { - "$ref": "#/definitions/defs_team" - }, - "type": "array" - } - }, - "required": [ - "ok", - "team_ids" - ], - "title": "admin.conversations.getTeams schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.getTeams", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "channel_not_found", - "channel_type_not_supported", - "unsupported_team_type", - "restricted_action", - "could_not_get_teams", - "invalid_cursor", - "invalid_limit" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.getTeams error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:read" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.invite": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Invite a user to a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.invite" - }, - "operationId": "admin_conversations_invite", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The users to invite.", - "in": "formData", - "name": "user_ids", - "required": true, - "type": "string" - }, - { - "description": "The channel that the users will be invited to.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.invite", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.invite schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for error response from admin.conversations.invite", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "channel_not_found", - "channel_type_not_supported", - "default_org_wide_channel", - "restricted_action", - "user_must_be_admin", - "failed_for_some_users" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.invite error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.rename": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Rename a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.rename" - }, - "operationId": "admin_conversations_rename", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to rename.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "in": "formData", - "name": "name", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.rename", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.rename schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.rename", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "channel_not_found", - "channel_type_not_supported", - "restricted_action", - "could_not_rename_channel", - "default_org_wide_channel", - "name_taken" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.restrictAccess.addGroup": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Add an allowlist of IDP groups for accessing a channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup" - }, - "operationId": "admin_conversations_restrictAccess_addGroup", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", - "in": "formData", - "name": "team_id", - "type": "string" - }, - { - "description": "The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.", - "in": "formData", - "name": "group_id", - "required": true, - "type": "string" - }, - { - "description": "The channel to link this group to.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" - ] - } - }, - "/admin.conversations.restrictAccess.listGroups": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all IDP Groups linked to a channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups" - }, - "operationId": "admin_conversations_restrictAccess_listGroups", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", - "in": "query", - "name": "team_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "group_ids": [ - "YOUR_GROUP_ID" - ], - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:read" - ] - } - ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" - ] - } - }, - "/admin.conversations.restrictAccess.removeGroup": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Remove a linked IDP group linked from a private channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup" - }, - "operationId": "admin_conversations_restrictAccess_removeGroup", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel.", - "in": "formData", - "name": "group_id", - "required": true, - "type": "string" - }, - { - "description": "The channel to remove the linked group from.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" - ] - } - }, - "/admin.conversations.search": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Search for public or private channels in an Enterprise organization.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.search" - }, - "operationId": "admin_conversations_search", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Comma separated string of team IDs, signifying the workspaces to search through.", - "in": "query", - "name": "team_ids", - "type": "string" - }, - { - "description": "Name of the the channel to query by.", - "in": "query", - "name": "query", - "type": "string" - }, - { - "description": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).", - "in": "query", - "name": "search_channel_types", - "type": "string" - }, - { - "description": "Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ", - "in": "query", - "name": "sort", - "type": "string" - }, - { - "description": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)", - "in": "query", - "name": "sort_dir", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channels": [ - { - "created": 1449252889, - "creator": "U012A3CDE", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "general", - "name_normalized": "general", - "num_members": 4, - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "This channel is for team-wide communication and announcements. All team members are in this channel." - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Company-wide announcements and work-based matters" - }, - "unlinked": 0 - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "dGVhbTpDMDYxRkE1UEI=" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.search", - "properties": { - "channels": { - "items": { - "$ref": "#/definitions/objs_channel" - }, - "type": "array" - }, - "next_cursor": { - "type": "string" - } - }, - "required": [ - "channels", - "next_cursor" - ], - "title": "admin.conversations.search schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "not_an_enterprise", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.search", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "not_an_admin", - "not_an_enterprise", - "team_not_found", - "not_allowed", - "invalid_auth", - "invalid_cursor", - "invalid_search_channel_type", - "invalid_sort", - "invalid_sort_dir" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.search error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:read" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.setConversationPrefs": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set the posting permissions for a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.setConversationPrefs" - }, - "operationId": "admin_conversations_setConversationPrefs", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to set the prefs for", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "description": "The prefs for this channel in a stringified JSON format.", - "in": "formData", - "name": "prefs", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.setConversationPrefs", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.setConversationPrefs schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.setConversationPrefs", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "not_an_admin", - "channel_not_found", - "channel_type_not_supported", - "restricted_action", - "missing_scope", - "could_not_set_channel_pref", - "default_org_wide_channel" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.setConversationPrefs error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.setTeams": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set the workspaces in an Enterprise grid org that connect to a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.setTeams" - }, - "operationId": "admin_conversations_setTeams", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The encoded `channel_id` to add or remove to workspaces.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - }, - { - "description": "The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.", - "in": "formData", - "name": "team_id", - "type": "string" - }, - { - "description": "A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.", - "in": "formData", - "name": "target_team_ids", - "type": "string" - }, - { - "description": "True if channel has to be converted to an org channel", - "in": "formData", - "name": "org_channel", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.unarchive": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Unarchive a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.unarchive" - }, - "operationId": "admin_conversations_unarchive", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.conversations:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The channel to unarchive.", - "in": "formData", - "name": "channel_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.unarchive", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "admin.conversations.unarchive schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from admin.conversations.unarchive", - "properties": { - "error": { - "enum": [ - "feature_not_enabled", - "channel_not_found", - "channel_not_archived", - "channel_type_not_supported", - "restricted_action", - "could_not_unarchive_channel", - "default_org_wide_channel", - "missing_scope" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.conversations:write" - ] - } - ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.emoji.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Add an emoji.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.add" - }, - "operationId": "admin_emoji_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.", - "in": "formData", - "name": "url", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.emoji.addAlias": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Add an emoji alias.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.addAlias" - }, - "operationId": "admin_emoji_addAlias", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The alias of the emoji.", - "in": "formData", - "name": "alias_for", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.emoji.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List emoji for an Enterprise Grid organization.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.list" - }, - "operationId": "admin_emoji_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "cache_ts": "1575283387.000000", - "categories": [ - { - "emoji_names": [ - "grinning", - "grin", - "joy", - "etc etc ..." - ], - "name": "Smileys & People" - } - ], - "categories_version": "5", - "emoji": { - "black_square": "alias:black_large_square", - "bowtie": "https://emoji.slack-edge.com/T9TK3CUKW/bowtie/f3ec6f2bb0.png", - "cubimal_chick": "https://emoji.slack-edge.com/T9TK3CUKW/cubimal_chick/85961c43d7.png", - "dusty_stick": "https://emoji.slack-edge.com/T9TK3CUKW/dusty_stick/6177a62312.png", - "glitch_crab": "https://emoji.slack-edge.com/T9TK3CUKW/glitch_crab/db049f1f9c.png", - "piggy": "https://emoji.slack-edge.com/T9TK3CUKW/piggy/b7762ee8cd.png", - "pride": "https://emoji.slack-edge.com/T9TK3CUKW/pride/56b1bd3388.png", - "shipit": "alias:squirrel", - "simple_smile": { - "apple": "https://a.slack-edge.com/80588/img/emoji_2017_12_06/apple/simple_smile.png", - "google": "https://a.slack-edge.com/80588/img/emoji_2017_12_06/google/simple_smile.png" - }, - "slack": "https://emoji.slack-edge.com/T9TK3CUKW/slack/7d462d2443.png", - "slack_call": "https://emoji.slack-edge.com/T9TK3CUKW/slack_call/b81fffd6dd.png", - "squirrel": "https://emoji.slack-edge.com/T9TK3CUKW/squirrel/465f40c0e0.png", - "thumbsup_all": "https://emoji.slack-edge.com/T9TK3CUKW/thumbsup_all/50096a1020.gif", - "white_square": "alias:white_large_square" - }, - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.emoji.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Remove an emoji across an Enterprise Grid organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.remove" - }, - "operationId": "admin_emoji_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.emoji.rename": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Rename an emoji.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.rename" - }, - "operationId": "admin_emoji_rename", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The new name of the emoji.", - "in": "formData", - "name": "new_name", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.inviteRequests.approve": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Approve a workspace invite request.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.inviteRequests.approve" - }, - "operationId": "admin_inviteRequests_approve", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.invites:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace where the invite request was made.", - "in": "formData", - "name": "team_id", - "type": "string" - }, - { - "description": "ID of the request to invite.", - "in": "formData", - "name": "invite_request_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.invites:write" - ] - } - ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.inviteRequests.approved.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List all approved workspace invite requests.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.inviteRequests.approved.list" - }, - "operationId": "admin_inviteRequests_approved_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.invites:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace where the invite requests were made.", - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "description": "Value of the `next_cursor` field sent as part of the previous API response", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.invites:read" - ] - } - ], - "tags": [ - "admin.inviteRequests.approved", - "admin" - ] - } - }, - "/admin.inviteRequests.denied.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List all denied workspace invite requests.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.inviteRequests.denied.list" - }, - "operationId": "admin_inviteRequests_denied_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.invites:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace where the invite requests were made.", - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "description": "Value of the `next_cursor` field sent as part of the previous api response", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.invites:read" - ] - } - ], - "tags": [ - "admin.inviteRequests.denied", - "admin" - ] - } - }, - "/admin.inviteRequests.deny": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deny a workspace invite request.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.inviteRequests.deny" - }, - "operationId": "admin_inviteRequests_deny", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.invites:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace where the invite request was made.", - "in": "formData", - "name": "team_id", - "type": "string" - }, - { - "description": "ID of the request to invite.", - "in": "formData", - "name": "invite_request_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.invites:write" - ] - } - ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.inviteRequests.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List all pending workspace invite requests.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.inviteRequests.list" - }, - "operationId": "admin_inviteRequests_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.invites:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace where the invite requests were made.", - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "description": "Value of the `next_cursor` field sent as part of the previous API response", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.invites:read" - ] - } - ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.teams.admins.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all of the admins on a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.admins.list" - }, - "operationId": "admin_teams_admins_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "admin_ids": [ - "U1234" - ], - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.teams.admins", - "admin" - ] - } - }, - "/admin.teams.create": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Create an Enterprise team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.create" - }, - "operationId": "admin_teams_create", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Team domain (for example, slacksoftballteam).", - "in": "formData", - "name": "team_domain", - "required": true, - "type": "string" - }, - { - "description": "Team name (for example, Slack Softball Team).", - "in": "formData", - "name": "team_name", - "required": true, - "type": "string" - }, - { - "description": "Description for the team.", - "in": "formData", - "name": "team_description", - "type": "string" - }, - { - "description": "Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`.", - "in": "formData", - "name": "team_discoverability", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "team": "T12345" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams", - "admin" - ] - } - }, - "/admin.teams.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List all teams on an Enterprise organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.list" - }, - "operationId": "admin_teams_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "teams": [ - { - "discoverability": "hidden", - "id": "T1234", - "name": "My Team", - "primary_owner": { - "email": "bront@slack.com", - "user_id": "W1234" - }, - "team_url": "https://subarachnoid.slack.com/" - } - ] - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.teams", - "admin" - ] - } - }, - "/admin.teams.owners.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all of the owners on a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.owners.list" - }, - "operationId": "admin_teams_owners_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "owner_ids": [ - "U1234" - ] - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.teams.owners", - "admin" - ] - } - }, - "/admin.teams.settings.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Fetch information about settings in a workspace", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.info" - }, - "operationId": "admin_teams_settings_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "team_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "team": { - "default_channels": "array", - "domain": "string", - "email_domain": "string", - "enterprise_id": "string", - "enterprise_name": "string", - "icon": "array", - "id": "string", - "name": "string" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.teams.settings.setDefaultChannels": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Set the default channels of a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDefaultChannels" - }, - "operationId": "admin_teams_settings_setDefaultChannels", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace to set the default channel for.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "An array of channel IDs.", - "in": "formData", - "name": "channel_ids", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.teams.settings.setDescription": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set the description of a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDescription" - }, - "operationId": "admin_teams_settings_setDescription", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace to set the description for.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The new description for the workspace.", - "in": "formData", - "name": "description", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.teams.settings.setDiscoverability": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "An API method that allows admins to set the discoverability of a given workspace", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDiscoverability" - }, - "operationId": "admin_teams_settings_setDiscoverability", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID of the workspace to set discoverability on.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.", - "in": "formData", - "name": "discoverability", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.teams.settings.setIcon": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Sets the icon of a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setIcon" - }, - "operationId": "admin_teams_settings_setIcon", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Image URL for the icon", - "in": "formData", - "name": "image_url", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace to set the icon for.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.teams.settings.setName": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set the name of a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setName" - }, - "operationId": "admin_teams_settings_setName", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID for the workspace to set the name for.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The new name of the workspace.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.teams.settings", - "admin" - ] - } - }, - "/admin.usergroups.addChannels": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Add one or more default channels to an IDP group.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.addChannels" - }, - "operationId": "admin_usergroups_addChannels", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID of the IDP group to add default channels for.", - "in": "formData", - "name": "usergroup_id", - "required": true, - "type": "string" - }, - { - "description": "The workspace to add default channels in.", - "in": "formData", - "name": "team_id", - "type": "string" - }, - { - "description": "Comma separated string of channel IDs.", - "in": "formData", - "name": "channel_ids", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", - "examples": { - "application/json": { - "error": "not_an_admin", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.usergroups:write" - ] - } - ], - "tags": [ - "admin.usergroups", - "admin" - ] - } - }, - "/admin.usergroups.addTeams": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Associate one or more default workspaces with an organization-wide IDP group.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.addTeams" - }, - "operationId": "admin_usergroups_addTeams", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.teams:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "An encoded usergroup (IDP Group) ID.", - "in": "formData", - "name": "usergroup_id", - "required": true, - "type": "string" - }, - { - "description": "A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token.", - "in": "formData", - "name": "team_ids", - "required": true, - "type": "string" - }, - { - "description": "When `true`, this method automatically creates new workspace accounts for the IDP group members.", - "in": "formData", - "name": "auto_provision", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.usergroups", - "admin" - ] - } - }, - "/admin.usergroups.listChannels": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List the channels linked to an org-level IDP group (user group).", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.listChannels" - }, - "operationId": "admin_usergroups_listChannels", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.usergroups:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID of the IDP group to list default channels for.", - "in": "query", - "name": "usergroup_id", - "required": true, - "type": "string" - }, - { - "description": "ID of the the workspace.", - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "description": "Flag to include or exclude the count of members per channel.", - "in": "query", - "name": "include_num_members", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channels": [ - { - "id": "C024BE91L", - "name": "fun", - "num_members": 34, - "team_id": "T024BE911" - }, - { - "id": "C024BE91K", - "name": "more fun", - "team_id": "T024BE912" - }, - { - "id": "C024BE91M", - "is_redacted": true, - "name": "public-channel", - "num_members": 34, - "team_id": "T024BE911" - }, - { - "id": "C024BE91N", - "name": "some more fun", - "team_id": "T024BE921" - } - ], - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", - "examples": { - "application/json": { - "error": "not_an_admin", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.usergroups:read" - ] - } - ], - "tags": [ - "admin.usergroups", - "admin" - ] - } - }, - "/admin.usergroups.removeChannels": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Remove one or more default channels from an org-level IDP group (user group).", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.removeChannels" - }, - "operationId": "admin_usergroups_removeChannels", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID of the IDP Group", - "in": "formData", - "name": "usergroup_id", - "required": true, - "type": "string" - }, - { - "description": "Comma-separated string of channel IDs", - "in": "formData", - "name": "channel_ids", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", - "examples": { - "application/json": { - "error": "not_an_admin", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.usergroups:write" - ] - } - ], - "tags": [ - "admin.usergroups", - "admin" - ] - } - }, - "/admin.users.assign": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Add an Enterprise user to a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.assign" - }, - "operationId": "admin_users_assign", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to add to the workspace.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - }, - { - "description": "True if user should be added to the workspace as a guest.", - "in": "formData", - "name": "is_restricted", - "type": "boolean" - }, - { - "description": "True if user should be added to the workspace as a single-channel guest.", - "in": "formData", - "name": "is_ultra_restricted", - "type": "boolean" - }, - { - "description": "Comma separated values of channel IDs to add user in the new workspace.", - "in": "formData", - "name": "channel_ids", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.invite": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Invite a user to a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.invite" - }, - "operationId": "admin_users_invite", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The email address of the person to invite.", - "in": "formData", - "name": "email", - "required": true, - "type": "string" - }, - { - "description": "A comma-separated list of `channel_id`s for this user to join. At least one channel is required.", - "in": "formData", - "name": "channel_ids", - "required": true, - "type": "string" - }, - { - "description": "An optional message to send to the user in the invite email.", - "in": "formData", - "name": "custom_message", - "type": "string" - }, - { - "description": "Full name of the user.", - "in": "formData", - "name": "real_name", - "type": "string" - }, - { - "description": "Allow this invite to be resent in the future if a user has not signed up yet. (default: false)", - "in": "formData", - "name": "resend", - "type": "boolean" - }, - { - "description": "Is this user a multi-channel guest user? (default: false)", - "in": "formData", - "name": "is_restricted", - "type": "boolean" - }, - { - "description": "Is this user a single channel guest user? (default: false)", - "in": "formData", - "name": "is_ultra_restricted", - "type": "boolean" - }, - { - "description": "Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.", - "in": "formData", - "name": "guest_expiration_ts", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "List users on a workspace", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.list" - }, - "operationId": "admin_users_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "query", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "Limit for how many users to be retrieved per page", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "users": [ - { - "email": "bront@slack.com", - "id": "T1234", - "is_admin": false, - "is_bot": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false - } - ] - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:read" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Remove a user from a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.remove" - }, - "operationId": "admin_users_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to remove.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.session.invalidate": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Invalidate a single session for a user by session_id", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.session.invalidate" - }, - "operationId": "admin_users_session_invalidate", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "ID of the team that the session belongs to", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "in": "formData", - "name": "session_id", - "required": true, - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users.session", - "admin" - ] - } - }, - "/admin.users.session.reset": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Wipes all valid sessions on all devices for a given user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.session.reset" - }, - "operationId": "admin_users_session_reset", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to wipe sessions for", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - }, - { - "description": "Only expire mobile sessions (default: false)", - "in": "formData", - "name": "mobile_only", - "type": "boolean" - }, - { - "description": "Only expire web sessions (default: false)", - "in": "formData", - "name": "web_only", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users.session", - "admin" - ] - } - }, - "/admin.users.setAdmin": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set an existing guest, regular user, or owner to be an admin user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setAdmin" - }, - "operationId": "admin_users_setAdmin", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to designate as an admin.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.setExpiration": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set an expiration for a guest user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setExpiration" - }, - "operationId": "admin_users_setExpiration", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to set an expiration for.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - }, - { - "description": "Timestamp when guest account should be disabled.", - "in": "formData", - "name": "expiration_ts", - "required": true, - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.setOwner": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set an existing guest, regular user, or admin user to be a workspace owner.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setOwner" - }, - "operationId": "admin_users_setOwner", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "Id of the user to promote to owner.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/admin.users.setRegular": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set an existing guest user, admin user, or owner to be a regular user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setRegular" - }, - "operationId": "admin_users_setRegular", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID (`T1234`) of the workspace.", - "in": "formData", - "name": "team_id", - "required": true, - "type": "string" - }, - { - "description": "The ID of the user to designate as a regular user.", - "in": "formData", - "name": "user_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin.users:write" - ] - } - ], - "tags": [ - "admin.users", - "admin" - ] - } - }, - "/api.test": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Checks API calling code.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/api.test" - }, - "operationId": "api_test", - "parameters": [ - { - "description": "Error response to return", - "in": "query", - "name": "error", - "type": "string" - }, - { - "description": "example property to return", - "in": "query", - "name": "foo", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": { - "type": "object" - }, - "description": "Schema for successful response api.test method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "api.test success schema", - "type": "object" - } - }, - "default": { - "description": "Artificial error response", - "examples": { - "application/json": { - "args": { - "error": "my_error" - }, - "error": "my_error", - "ok": false - } - }, - "schema": { - "additionalProperties": { - "type": "object" - }, - "description": "Schema for error response api.test method", - "properties": { - "error": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "api.test error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "api" - ] - } - }, - "/apps.event.authorizations.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.event.authorizations.list" - }, - "operationId": "apps_event_authorizations_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `authorizations:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "event_context", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "authorizations": { - "enterprise_id": "string", - "is_bot": "string", - "team_id": "string", - "user_id": "string" - }, - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "authorizations:read" - ] - } - ], - "tags": [ - "apps.event.authorizations", - "apps" - ] - } - }, - "/apps.permissions.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Returns list of permissions this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.info" - }, - "operationId": "apps_permissions_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response when used with a user token", - "examples": { - "application/json": { - "info": { - "app_home": { - "resources": { - "ids": [ - "D0C0NU1Q8", - "D0BH95DLH" - ] - }, - "scopes": [ - "chat:write", - "im:history", - "im:read" - ] - }, - "channel": { - "resources": { - "excluded_ids": [], - "ids": [ - "C061FA5PB" - ], - "wildcard": false - }, - "scopes": [ - "channels:read" - ] - }, - "group": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "im": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "mpim": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "team": { - "resources": { - "ids": [] - }, - "scopes": [] - } - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from apps.permissions.info method", - "properties": { - "info": { - "properties": { - "app_home": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - }, - "channel": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - }, - "group": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - }, - "im": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - }, - "mpim": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - }, - "team": { - "properties": { - "resources": { - "$ref": "#/definitions/objs_resources" - }, - "scopes": { - "$ref": "#/definitions/objs_scopes" - } - }, - "required": [ - "scopes", - "resources" - ], - "type": "object" - } - }, - "required": [ - "team", - "channel", - "group", - "mpim", - "im", - "app_home" - ], - "type": "object" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "info" - ], - "title": "apps.permissions.info schema", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when used with an invalid token", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from apps.permissions.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "apps.permissions.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions", - "apps" - ] - } - }, - "/apps.permissions.request": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Allows an app to request additional scopes", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.request" - }, - "operationId": "apps_permissions_request", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A comma separated list of scopes to request for", - "in": "query", - "name": "scopes", - "required": true, - "type": "string" - }, - { - "description": "Token used to trigger the permissions API", - "in": "query", - "name": "trigger_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response when used with a user token", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from apps.permissions.request method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "apps.permissions.request schema", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when trigger_id is invalid", - "examples": { - "application/json": { - "error": "invalid_trigger_id", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from apps.permissions.request method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_trigger", - "trigger_exchanged", - "invalid_scope", - "invalid_user", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "apps.permissions.request error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions", - "apps" - ] - } - }, - "/apps.permissions.resources.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Returns list of resource grants this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.resources.list" - }, - "operationId": "apps_permissions_resources_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical successful paginated response", - "examples": { - "application/json": { - "ok": true, - "resources": [ - { - "id": "T0DES3UAN", - "type": "team" - }, - { - "id": "D024BFF1M", - "type": "app_home" - }, - { - "id": "C024BE91L", - "type": "channel" - } - ], - "response_metadata": { - "next_cursor": "dGVhbTpDMUg5UkVTR0w=" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response apps.permissions.resources.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "resources": { - "items": { - "properties": { - "id": { - "title": "An ID for a resource", - "type": "string", - "x-examples": [ - "T0DES3UAN", - "C0ABC1ABC" - ] - }, - "type": { - "title": "The type of resource the `id` corresponds to", - "type": "string", - "x-examples": [ - "team", - "channel", - "mpim" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string", - "x-examples": [ - "dGVhbTpDMUg5UkVTR0w=" - ] - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "resources" - ], - "title": "apps.permissions.resources.list success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_cursor", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from apps.permissions.resources.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_cursor", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "apps.permissions.resources.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions.resources", - "apps" - ] - } - }, - "/apps.permissions.scopes.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Returns list of scopes this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.scopes.list" - }, - "operationId": "apps_permissions_scopes_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical successful paginated response", - "examples": { - "application/json": { - "ok": true, - "scopes": { - "app_home": [ - "chat:write", - "im:history", - "im:read" - ], - "channel": [ - "channels:history", - "chat:write" - ], - "group": [ - "chat:write" - ], - "im": [ - "chat:write" - ], - "mpim": [ - "chat:write" - ], - "team": [ - "users:read" - ], - "user": [] - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response api.permissions.scopes.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "scopes": { - "additionalProperties": true, - "properties": { - "app_home": { - "$ref": "#/definitions/objs_scopes" - }, - "channel": { - "$ref": "#/definitions/objs_scopes" - }, - "group": { - "$ref": "#/definitions/objs_scopes" - }, - "im": { - "$ref": "#/definitions/objs_scopes" - }, - "mpim": { - "$ref": "#/definitions/objs_scopes" - }, - "team": { - "$ref": "#/definitions/objs_scopes" - }, - "user": { - "$ref": "#/definitions/objs_scopes" - } - }, - "type": "object" - } - }, - "required": [ - "ok", - "scopes" - ], - "title": "api.permissions.scopes.list success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from apps.permissions.scopes.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "apps.permissions.scopes.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions.scopes", - "apps" - ] - } - }, - "/apps.permissions.users.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Returns list of user grants and corresponding scopes this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.users.list" - }, - "operationId": "apps_permissions_users_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical successful paginated response", - "examples": { - "application/json": { - "ok": true, - "resources": [ - { - "id": "U0DES3UAN", - "scopes": [ - "dnd:write:user", - "reminders:write:user" - ] - }, - { - "id": "U024BFF1M", - "scopes": [ - "reminders:write:user" - ] - } - ], - "response_metadata": { - "next_cursor": "dGVhbTdPMUg5UkFTT0w=" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_cursor", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions.users", - "apps" - ] - } - }, - "/apps.permissions.users.request": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Enables an app to trigger a permissions modal to grant an app access to a user access scope.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.users.request" - }, - "operationId": "apps_permissions_users_request", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A comma separated list of user scopes to request for", - "in": "query", - "name": "scopes", - "required": true, - "type": "string" - }, - { - "description": "Token used to trigger the request", - "in": "query", - "name": "trigger_id", - "required": true, - "type": "string" - }, - { - "description": "The user this scope is being requested for", - "in": "query", - "name": "user", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response when used with a user token", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when trigger_id is invalid", - "examples": { - "application/json": { - "error": "invalid_trigger_id", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps.permissions.users", - "apps" - ] - } - }, - "/apps.uninstall": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Uninstalls your app from a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.uninstall" - }, - "operationId": "apps_uninstall", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_id", - "type": "string" - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_secret", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from apps.uninstall method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "apps.uninstall schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from apps.uninstall method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_client_id", - "bad_client_secret", - "client_id_token_mismatch", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "apps.uninstall error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "apps" - ] - } - }, - "/auth.revoke": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Revokes a token.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/auth.revoke" - }, - "operationId": "auth_revoke", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.", - "in": "query", - "name": "test", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "revoked": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from auth.revoke method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "revoked": { - "type": "boolean" - } - }, - "required": [ - "ok", - "revoked" - ], - "title": "auth.revoke schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from auth.revoke method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "auth.revoke error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "auth" - ] - } - }, - "/auth.test": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Checks authentication & identity.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/auth.test" - }, - "operationId": "auth_test", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response when used with a user token", - "examples": { - "application/json": { - "ok": true, - "team": "Subarachnoid Workspace", - "team_id": "T12345678", - "url": "https://subarachnoid.slack.com/", - "user": "grace", - "user_id": "W12345678" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response auth.test method", - "properties": { - "bot_id": { - "$ref": "#/definitions/defs_bot_id" - }, - "is_enterprise_install": { - "type": "boolean" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "type": "string" - }, - "team_id": { - "$ref": "#/definitions/defs_team" - }, - "url": { - "type": "string" - }, - "user": { - "type": "string" - }, - "user_id": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "ok", - "url", - "team", - "user", - "team_id", - "user_id" - ], - "title": "auth.test success schema", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when used with an invalid token", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response auth.test method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "token_revoked", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "auth.test error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "auth" - ] - } - }, - "/bots.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets information about a bot user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/bots.info" - }, - "operationId": "bots_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Bot user to get info on", - "in": "query", - "name": "bot", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "When successful, returns bot info by bot ID.", - "examples": { - "application/json": { - "bot": { - "app_id": "A161CLERW", - "deleted": false, - "icons": { - "image_36": "https://...", - "image_48": "https://...", - "image_72": "https://..." - }, - "id": "B061F7JD2", - "name": "beforebot", - "updated": 1449272004, - "user_id": "U012ABCDEF" - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from bots.info method", - "properties": { - "bot": { - "additionalProperties": false, - "properties": { - "app_id": { - "$ref": "#/definitions/defs_app_id" - }, - "deleted": { - "type": "boolean" - }, - "icons": { - "additionalProperties": false, - "properties": { - "image_36": { - "format": "uri", - "type": "string" - }, - "image_48": { - "format": "uri", - "type": "string" - }, - "image_72": { - "format": "uri", - "type": "string" - } - }, - "required": [ - "image_36", - "image_48", - "image_72" - ], - "type": "object" - }, - "id": { - "$ref": "#/definitions/defs_bot_id" - }, - "name": { - "type": "string" - }, - "updated": { - "type": "integer" - }, - "user_id": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "id", - "deleted", - "name", - "updated", - "app_id", - "icons" - ], - "type": "object" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "bot" - ], - "title": "bots.info schema", - "type": "object" - } - }, - "default": { - "description": "When no bot can be found, it returns an error.", - "examples": { - "application/json": { - "error": "bot_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from bots.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bot_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "bots.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:read" - ] - } - ], - "tags": [ - "bots" - ] - } - }, - "/calls.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Registers a new Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.add" - }, - "operationId": "calls_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.", - "in": "formData", - "name": "external_unique_id", - "required": true, - "type": "string" - }, - { - "description": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.", - "in": "formData", - "name": "external_display_id", - "type": "string" - }, - { - "description": "The URL required for a client to join the Call.", - "in": "formData", - "name": "join_url", - "required": true, - "type": "string" - }, - { - "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", - "in": "formData", - "name": "desktop_app_join_url", - "type": "string" - }, - { - "description": "Call start time in UTC UNIX timestamp format", - "in": "formData", - "name": "date_start", - "type": "integer" - }, - { - "description": "The name of the Call.", - "in": "formData", - "name": "title", - "type": "string" - }, - { - "description": "The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.", - "in": "formData", - "name": "created_by", - "type": "string" - }, - { - "description": "The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", - "in": "formData", - "name": "users", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:write" - ] - } - ], - "tags": [ - "calls" - ] - } - }, - "/calls.end": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Ends a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.end" - }, - "operationId": "calls_end", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.", - "in": "formData", - "name": "id", - "required": true, - "type": "string" - }, - { - "description": "Call duration in seconds", - "in": "formData", - "name": "duration", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:write" - ] - } - ], - "tags": [ - "calls" - ] - } - }, - "/calls.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Returns information about a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.info" - }, - "operationId": "calls_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:read`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.", - "in": "query", - "name": "id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:read" - ] - } - ], - "tags": [ - "calls" - ] - } - }, - "/calls.participants.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Registers new participants added to a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.participants.add" - }, - "operationId": "calls_participants_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", - "in": "formData", - "name": "id", - "required": true, - "type": "string" - }, - { - "description": "The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", - "in": "formData", - "name": "users", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:write" - ] - } - ], - "tags": [ - "calls.participants", - "calls" - ] - } - }, - "/calls.participants.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Registers participants removed from a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.participants.remove" - }, - "operationId": "calls_participants_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", - "in": "formData", - "name": "id", - "required": true, - "type": "string" - }, - { - "description": "The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).", - "in": "formData", - "name": "users", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:write" - ] - } - ], - "tags": [ - "calls.participants", - "calls" - ] - } - }, - "/calls.update": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Updates information about a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.update" - }, - "operationId": "calls_update", - "parameters": [ - { - "description": "Authentication token. Requires scope: `calls:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` returned by the [`calls.add`](/methods/calls.add) method.", - "in": "formData", - "name": "id", - "required": true, - "type": "string" - }, - { - "description": "The name of the Call.", - "in": "formData", - "name": "title", - "type": "string" - }, - { - "description": "The URL required for a client to join the Call.", - "in": "formData", - "name": "join_url", - "type": "string" - }, - { - "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.", - "in": "formData", - "name": "desktop_app_join_url", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "calls:write" - ] - } - ], - "tags": [ - "calls" - ] - } - }, - "/chat.delete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deletes a message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.delete" - }, - "operationId": "chat_delete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Timestamp of the message to be deleted.", - "in": "formData", - "name": "ts", - "type": "number" - }, - { - "description": "Channel containing the message to be deleted.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.", - "in": "formData", - "name": "as_user", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": "C024BE91L", - "ok": true, - "ts": "1401383885.000061" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of chat.delete method", - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - } - }, - "required": [ - "ok", - "channel", - "ts" - ], - "title": "chat.delete success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "message_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.delete method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "message_not_found", - "channel_not_found", - "cant_delete_message", - "compliance_exports_prevent_deletion", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.delete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.deleteScheduledMessage": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deletes a pending scheduled message from the queue.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.deleteScheduledMessage" - }, - "operationId": "chat_deleteScheduledMessage", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.", - "in": "formData", - "name": "as_user", - "type": "boolean" - }, - { - "description": "The channel the scheduled_message is posting to", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "`scheduled_message_id` returned from call to chat.scheduleMessage", - "in": "formData", - "name": "scheduled_message_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from chat.deleteScheduledMessage method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "chat.deleteScheduledMessage schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response if no message is found", - "examples": { - "application/json": { - "error": "invalid_scheduled_message_id", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.deleteScheduledMessage method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_scheduled_message_id", - "channel_not_found", - "bad_token", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "ekm_access_denied", - "missing_scope", - "invalid_arguments", - "invalid_arg_name", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.deleteScheduledMessage error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.getPermalink": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve a permalink URL for a specific extant message", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.getPermalink" - }, - "operationId": "chat_getPermalink", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The ID of the conversation or channel containing the message", - "in": "query", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "A message's `ts` value, uniquely identifying it within a channel", - "in": "query", - "name": "message_ts", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response", - "examples": { - "application/json": { - "channel": "C1H9RESGA", - "ok": true, - "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response chat.getPermalink", - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "permalink": { - "format": "uri", - "type": "string" - } - }, - "required": [ - "ok", - "channel", - "permalink" - ], - "title": "chat.getPermalink success schema", - "type": "object" - } - }, - "default": { - "description": "Error response when channel cannot be found", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.getPermalink method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "message_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.getPermalink error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.meMessage": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Share a me message into a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.meMessage" - }, - "operationId": "chat_meMessage", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "Text of the message to send.", - "in": "formData", - "name": "text", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": "C024BE7LR", - "ok": true, - "ts": "1417671948.000006" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from chat.meMessage method", - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - } - }, - "required": [ - "ok" - ], - "title": "chat.meMessage schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.meMessage method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "not_in_channel", - "is_archived", - "msg_too_long", - "no_text", - "rate_limited", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.meMessage error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.postEphemeral": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Sends an ephemeral message to a user in a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.postEphemeral" - }, - "operationId": "chat_postEphemeral", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.", - "in": "formData", - "name": "as_user", - "type": "boolean" - }, - { - "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", - "in": "formData", - "name": "attachments", - "type": "string" - }, - { - "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", - "in": "formData", - "name": "blocks", - "type": "string" - }, - { - "description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "icon_emoji", - "type": "string" - }, - { - "description": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "icon_url", - "type": "string" - }, - { - "description": "Find and link channel names and usernames.", - "in": "formData", - "name": "link_names", - "type": "boolean" - }, - { - "description": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", - "in": "formData", - "name": "parse", - "type": "string" - }, - { - "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", - "in": "formData", - "name": "text", - "type": "string" - }, - { - "description": "Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.", - "in": "formData", - "name": "thread_ts", - "type": "string" - }, - { - "description": "`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.", - "in": "formData", - "name": "user", - "required": true, - "type": "string" - }, - { - "description": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "username", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "message_ts": "1502210682.580145", - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from chat.postEphemeral method", - "properties": { - "message_ts": { - "$ref": "#/definitions/defs_ts" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "message_ts" - ], - "title": "chat.postEphemeral success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "user_not_in_channel", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.postEphemeral method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "is_archived", - "msg_too_long", - "no_text", - "restricted_action", - "too_many_attachments", - "user_not_in_channel", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.postEphemeral error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.postMessage": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Sends a message to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.postMessage" - }, - "operationId": "chat_postMessage", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.", - "in": "formData", - "name": "as_user", - "type": "string" - }, - { - "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", - "in": "formData", - "name": "attachments", - "type": "string" - }, - { - "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", - "in": "formData", - "name": "blocks", - "type": "string" - }, - { - "description": "Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "icon_emoji", - "type": "string" - }, - { - "description": "URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "icon_url", - "type": "string" - }, - { - "description": "Find and link channel names and usernames.", - "in": "formData", - "name": "link_names", - "type": "boolean" - }, - { - "description": "Disable Slack markup parsing by setting to `false`. Enabled by default.", - "in": "formData", - "name": "mrkdwn", - "type": "boolean" - }, - { - "description": "Change how messages are treated. Defaults to `none`. See [below](#formatting).", - "in": "formData", - "name": "parse", - "type": "string" - }, - { - "description": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", - "in": "formData", - "name": "reply_broadcast", - "type": "boolean" - }, - { - "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", - "in": "formData", - "name": "text", - "type": "string" - }, - { - "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", - "in": "formData", - "name": "thread_ts", - "type": "string" - }, - { - "description": "Pass true to enable unfurling of primarily text-based content.", - "in": "formData", - "name": "unfurl_links", - "type": "boolean" - }, - { - "description": "Pass false to disable unfurling of media content.", - "in": "formData", - "name": "unfurl_media", - "type": "boolean" - }, - { - "description": "Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.", - "in": "formData", - "name": "username", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": "C1H9RESGL", - "message": { - "attachments": [ - { - "fallback": "This is an attachment's fallback", - "id": 1, - "text": "This is an attachment" - } - ], - "bot_id": "B19LU7CSY", - "subtype": "bot_message", - "text": "Here's a message for you", - "ts": "1503435956.000247", - "type": "message", - "username": "ecto1" - }, - "ok": true, - "ts": "1503435956.000247" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of chat.postMessage method", - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "message": { - "$ref": "#/definitions/objs_message" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - } - }, - "required": [ - "ok", - "channel", - "ts", - "message" - ], - "title": "chat.postMessage success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response if too many attachments are included", - "examples": { - "application/json": { - "error": "too_many_attachments", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response chat.postMessage method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "not_in_channel", - "is_archived", - "msg_too_long", - "no_text", - "too_many_attachments", - "rate_limited", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.postMessage error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.scheduleMessage": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Schedules a message to be sent to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.scheduleMessage" - }, - "operationId": "chat_scheduleMessage", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.", - "in": "formData", - "name": "text", - "type": "string" - }, - { - "description": "Unix EPOCH timestamp of time in future to send the message.", - "in": "formData", - "name": "post_at", - "type": "string" - }, - { - "description": "Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting).", - "in": "formData", - "name": "parse", - "type": "string" - }, - { - "description": "Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship).", - "in": "formData", - "name": "as_user", - "type": "boolean" - }, - { - "description": "Find and link channel names and usernames.", - "in": "formData", - "name": "link_names", - "type": "boolean" - }, - { - "description": "A JSON-based array of structured attachments, presented as a URL-encoded string.", - "in": "formData", - "name": "attachments", - "type": "string" - }, - { - "description": "A JSON-based array of structured blocks, presented as a URL-encoded string.", - "in": "formData", - "name": "blocks", - "type": "string" - }, - { - "description": "Pass true to enable unfurling of primarily text-based content.", - "in": "formData", - "name": "unfurl_links", - "type": "boolean" - }, - { - "description": "Pass false to disable unfurling of media content.", - "in": "formData", - "name": "unfurl_media", - "type": "boolean" - }, - { - "description": "Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.", - "in": "formData", - "name": "thread_ts", - "type": "number" - }, - { - "description": "Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.", - "in": "formData", - "name": "reply_broadcast", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": "C1H9RESGL", - "message": { - "attachments": [ - { - "fallback": "This is an attachment's fallback", - "id": 1, - "text": "This is an attachment" - } - ], - "bot_id": "B19LU7CSY", - "subtype": "bot_message", - "text": "Here's a message for you in the future", - "type": "delayed_message", - "username": "ecto1" - }, - "ok": true, - "post_at": "1562180400", - "scheduled_message_id": "Q1298393284" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of chat.scheduleMessage method", - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "message": { - "additionalProperties": false, - "properties": { - "bot_id": { - "$ref": "#/definitions/defs_bot_id" - }, - "bot_profile": { - "$ref": "#/definitions/objs_bot_profile" - }, - "team": { - "$ref": "#/definitions/defs_team" - }, - "text": { - "type": "string" - }, - "type": { - "type": "string" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "username": { - "type": "string" - } - }, - "required": [ - "type", - "text", - "bot_id", - "user", - "team" - ], - "type": "object" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "post_at": { - "pattern": "^\\d{10}$", - "type": "integer" - }, - "scheduled_message_id": { - "pattern": "^[Q][A-Z0-9]{8,}$", - "title": "Scheduled Message ID", - "type": "string" - } - }, - "required": [ - "ok", - "channel", - "post_at", - "scheduled_message_id", - "message" - ], - "title": "chat.scheduleMessage success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)", - "examples": { - "application/json": { - "error": "time_in_past", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response chat.scheduleMessage method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_time", - "time_in_past", - "time_too_far", - "channel_not_found", - "not_in_channel", - "is_archived", - "msg_too_long", - "no_text", - "restricted_action", - "restricted_action_read_only_channel", - "restricted_action_thread_only_channel", - "restricted_action_non_threadable_channel", - "too_many_attachments", - "rate_limited", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "ekm_access_denied", - "missing_scope", - "invalid_arguments", - "invalid_arg_name", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.scheduleMessage error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.scheduledMessages.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Returns a list of scheduled messages.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.scheduledMessages.list" - }, - "operationId": "chat_scheduledMessages_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "The channel of the scheduled messages", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "A UNIX timestamp of the latest value in the time range", - "in": "query", - "name": "latest", - "type": "number" - }, - { - "description": "A UNIX timestamp of the oldest value in the time range", - "in": "query", - "name": "oldest", - "type": "number" - }, - { - "description": "Maximum number of original entries to return.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "response_metadata": { - "next_cursor": "" - }, - "scheduled_messages": [ - { - "channel_id": "C1H9RESGL", - "date_created": 1551891734, - "id": 1298393284, - "post_at": 1551991428, - "text": "Here's a message for you in the future" - } - ] - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from chat.scheduledMessages.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - }, - "scheduled_messages": { - "items": { - "additionalProperties": false, - "properties": { - "channel_id": { - "$ref": "#/definitions/defs_channel_id" - }, - "date_created": { - "pattern": "^\\d{10}$", - "type": "integer" - }, - "id": { - "pattern": "^[Q][A-Z0-9]{8,}$", - "type": "string" - }, - "post_at": { - "pattern": "^\\d{10}$", - "type": "integer" - }, - "text": { - "type": "string" - } - }, - "required": [ - "id", - "channel_id", - "post_at", - "date_created" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "ok", - "scheduled_messages", - "response_metadata" - ], - "title": "chat.scheduledMessages.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the channel passed is invalid", - "examples": { - "application/json": { - "error": "invalid_channel", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.scheduledMessages.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_channel", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "ekm_access_denied", - "missing_scope", - "invalid_arguments", - "invalid_arg_name", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.scheduledMessages.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "chat.scheduledMessages", - "chat" - ] - } - }, - "/chat.unfurl": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Provide custom unfurl behavior for user-posted URLs", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.unfurl" - }, - "operationId": "chat_unfurl", - "parameters": [ - { - "description": "Authentication token. Requires scope: `links:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel ID of the message", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Timestamp of the message to add unfurl behavior to.", - "in": "formData", - "name": "ts", - "required": true, - "type": "string" - }, - { - "description": "URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.", - "in": "formData", - "name": "unfurls", - "type": "string" - }, - { - "description": "Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior", - "in": "formData", - "name": "user_auth_message", - "type": "string" - }, - { - "description": "Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain", - "in": "formData", - "name": "user_auth_required", - "type": "boolean" - }, - { - "description": "Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.", - "in": "formData", - "name": "user_auth_url", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical, minimal success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from chat.unfurl method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "chat.unfurl success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "cannot_unfurl_url", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from chat.unfurl method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "cannot_unfurl_url", - "cannot_find_service", - "missing_unfurls", - "cannot_prompt", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.unfurl error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "links:write" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.update": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Updates a message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.update" - }, - "operationId": "chat_update", - "parameters": [ - { - "description": "Authentication token. Requires scope: `chat:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.", - "in": "formData", - "name": "as_user", - "type": "string" - }, - { - "description": "A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field.", - "in": "formData", - "name": "attachments", - "type": "string" - }, - { - "description": "A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.", - "in": "formData", - "name": "blocks", - "type": "string" - }, - { - "description": "Channel containing the message to be updated.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`.", - "in": "formData", - "name": "link_names", - "type": "string" - }, - { - "description": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`.", - "in": "formData", - "name": "parse", - "type": "string" - }, - { - "description": "New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`.", - "in": "formData", - "name": "text", - "type": "string" - }, - { - "description": "Timestamp of the message to be updated.", - "in": "formData", - "name": "ts", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": "C024BE91L", - "message": { - "text": "Updated text you carefully authored", - "user": "U34567890" - }, - "ok": true, - "text": "Updated text you carefully authored", - "ts": "1401383885.000061" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of chat.update method", - "properties": { - "channel": { - "type": "string" - }, - "message": { - "properties": { - "attachments": { - "items": { - "type": "object" - }, - "type": "array" - }, - "blocks": { - "type": "object" - }, - "text": { - "type": "string" - } - }, - "required": [ - "text" - ], - "title": "Message object", - "type": "object" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "text": { - "type": "string" - }, - "ts": { - "type": "string" - } - }, - "required": [ - "ok", - "channel", - "ts", - "text", - "message" - ], - "title": "chat.update success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "cant_update_message", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response chat.update method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "message_not_found", - "cant_update_message", - "channel_not_found", - "edit_window_closed", - "msg_too_long", - "too_many_attachments", - "rate_limited", - "no_text", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "request_timeout", - "invalid_json", - "json_not_object", - "upgrade_required", - "fatal_error", - "is_inactive" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.update error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/conversations.archive": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Archives a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.archive" - }, - "operationId": "conversations_archive", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of conversation to archive", - "in": "formData", - "name": "channel", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.archive method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.archive success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.archive method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "not_supported", - "channel_not_found", - "already_archived", - "cant_archive_general", - "restricted_action", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.archive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.close": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Closes a direct message or multi-person direct message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.close" - }, - "operationId": "conversations_close", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Conversation to close.", - "in": "formData", - "name": "channel", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.close method", - "properties": { - "already_closed": { - "type": "boolean" - }, - "no_op": { - "type": "boolean" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.close success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.close method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "channel_not_found", - "user_does_not_own_channel", - "missing_scope", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.close error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.create": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Initiates a public or private channel-based conversation", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.create" - }, - "operationId": "conversations_create", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Name of the public or private channel to create", - "in": "formData", - "name": "name", - "type": "string" - }, - { - "description": "Create a private channel instead of a public one", - "in": "formData", - "name": "is_private", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "If successful, the command returns a rather stark [conversation object](/types/conversation)", - "examples": { - "application/json": { - "channel": { - "created": 1504554479, - "creator": "U0123456", - "id": "C0EAQDV4Z", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": false, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "last_read": "0000000000.000000", - "latest": null, - "name": "endeavor", - "name_normalized": "endeavor", - "pending_shared": [], - "previous_names": [], - "priority": 0, - "purpose": { - "creator": "", - "last_set": 0, - "value": "" - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "" - }, - "unlinked": 0, - "unread_count": 0, - "unread_count_display": 0 - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.create method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.create success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when name already in use", - "examples": { - "application/json": { - "error": "name_taken", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.create method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "detail": { - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "name_taken", - "restricted_action", - "no_channel", - "invalid_name_required", - "invalid_name_punctuation", - "invalid_name_maxlength", - "invalid_name_specials", - "invalid_name", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.create error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.history": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Fetches a conversation's history of messages and events.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.history" - }, - "operationId": "conversations_history", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:history`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Conversation ID to fetch history for.", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "End of time range of messages to include in results.", - "in": "query", - "name": "latest", - "type": "number" - }, - { - "description": "Start of time range of messages to include in results.", - "in": "query", - "name": "oldest", - "type": "number" - }, - { - "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "in": "query", - "name": "inclusive", - "type": "boolean" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response containing a channel's messages", - "examples": { - "application/json": { - "has_more": true, - "messages": [ - { - "text": "I find you punny and would like to smell your nose letter", - "ts": "1512085950.000216", - "type": "message", - "user": "U012AB3CDE" - }, - { - "text": "What, you want to smell my shoes better?", - "ts": "1512104434.000490", - "type": "message", - "user": "U061F7AUR" - } - ], - "ok": true, - "pin_count": 0, - "response_metadata": { - "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.history method", - "properties": { - "channel_actions_count": { - "type": "integer" - }, - "channel_actions_ts": { - "items": [ - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "has_more": { - "type": "boolean" - }, - "messages": { - "items": { - "$ref": "#/definitions/objs_message" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "pin_count": { - "type": "integer" - } - }, - "required": [ - "ok", - "messages", - "has_more", - "pin_count", - "channel_actions_ts", - "channel_actions_count" - ], - "title": "conversations.history success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.history method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "missing_scope", - "channel_not_found", - "invalid_ts_latest", - "invalid_ts_oldest", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.history error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:history", - "groups:history", - "im:history", - "mpim:history" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve information about a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.info" - }, - "operationId": "conversations_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Conversation ID to learn more about", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", - "in": "query", - "name": "include_locale", - "type": "boolean" - }, - { - "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", - "in": "query", - "name": "include_num_members", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)", - "examples": { - "application/json": { - "channel": { - "created": 1449252889, - "creator": "W012A3BCD", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_read_only": false, - "is_shared": false, - "last_read": "1502126650.228446", - "locale": "en-US", - "name": "general", - "name_normalized": "general", - "parent_conversation": null, - "pending_shared": [], - "previous_names": [ - "specifics", - "abstractions", - "etc" - ], - "purpose": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "This part of the workspace is for fun. Make fun here." - }, - "topic": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "For public discussion of generalities" - }, - "unlinked": 0 - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.info", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.info success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when a channel cannot be found", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "missing_scope", - "channel_not_found", - "team_added_to_org", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:read", - "groups:read", - "im:read", - "mpim:read" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.invite": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Invites users to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.invite" - }, - "operationId": "conversations_invite", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "The ID of the public or private channel to invite user(s) to.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "A comma separated list of user IDs. Up to 1000 users may be listed.", - "in": "formData", - "name": "users", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response when an invitation is extended", - "examples": { - "application/json": { - "channel": { - "created": 1449252889, - "creator": "W012A3BCD", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_read_only": false, - "is_shared": false, - "last_read": "1502126650.228446", - "locale": "en-US", - "name": "general", - "name_normalized": "general", - "num_members": 23, - "pending_shared": [], - "previous_names": [ - "specifics", - "abstractions", - "etc" - ], - "purpose": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "This part of the workspace is for fun. Make fun here." - }, - "topic": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "For public discussion of generalities" - }, - "unlinked": 0 - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.invite method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.invite error schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when an invite is attempted on a conversation type that does not support it", - "examples": { - "application/json": { - "error": "method_not_supported_for_channel_type", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.invite method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "user_not_found", - "no_user", - "cant_invite_self", - "not_in_channel", - "already_in_channel", - "is_archived", - "cant_invite", - "too_many_users", - "ura_max_channels", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "errors": { - "items": { - "additionalProperties": false, - "properties": { - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "user_not_found", - "no_user", - "cant_invite_self", - "not_in_channel", - "already_in_channel", - "is_archived", - "cant_invite", - "too_many_users", - "ura_max_channels", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "ok", - "error" - ], - "type": "object" - }, - "minItems": 1, - "title": "errors is returned when an error associates an user", - "type": "array", - "uniqueItems": true - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok" - ], - "title": "conversations.invite error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.join": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Joins an existing conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.join" - }, - "operationId": "conversations_join", - "parameters": [ - { - "description": "Authentication token. Requires scope: `channels:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of conversation to join", - "in": "formData", - "name": "channel", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": { - "created": 1449252889, - "creator": "U061F7AUR", - "id": "C061EG9SL", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "general", - "name_normalized": "general", - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "For widget discussion" - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Which widget do you worry about?" - }, - "unlinked": 0 - }, - "ok": true, - "response_metadata": { - "warnings": [ - "already_in_channel" - ] - }, - "warning": "already_in_channel" - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.join method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "properties": { - "warnings": { - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "title": "Response metadata", - "type": "object" - }, - "warning": { - "type": "string" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.join success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response if the conversation is archived and cannot be joined", - "examples": { - "application/json": { - "error": "is_archived", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.join method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "is_archived", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.join error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.kick": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Removes a user from a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.kick" - }, - "operationId": "conversations_kick", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of conversation to remove user from.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "User ID to be removed.", - "in": "formData", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.kick method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.kick success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when you attempt to kick yourself from a channel", - "examples": { - "application/json": { - "error": "cant_kick_self", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response conversations.kick method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "user_not_found", - "cant_kick_self", - "not_in_channel", - "cant_kick_from_general", - "restricted_action", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.kick error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.leave": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Leaves a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.leave" - }, - "operationId": "conversations_leave", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Conversation to leave", - "in": "formData", - "name": "channel", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.leave method", - "properties": { - "not_in_channel": { - "enum": [ - true - ], - "type": "boolean" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.leave success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when attempting to leave a workspace's \"general\" channel", - "examples": { - "application/json": { - "error": "cant_leave_general", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.leave method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "last_member", - "missing_scope", - "channel_not_found", - "is_archived", - "cant_leave_general", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.leave error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists all channels in a Slack team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.list" - }, - "operationId": "conversations_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Set to `true` to exclude archived channels from the list", - "in": "query", - "name": "exclude_archived", - "type": "boolean" - }, - { - "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "in": "query", - "name": "types", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response with only public channels", - "examples": { - "application/json": { - "channels": [ - { - "created": 1449252889, - "creator": "U012A3CDE", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "general", - "name_normalized": "general", - "num_members": 4, - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "This channel is for team-wide communication and announcements. All team members are in this channel." - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Company-wide announcements and work-based matters" - }, - "unlinked": 0 - }, - { - "created": 1449252889, - "creator": "U061F7AUR", - "id": "C061EG9T2", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": false, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "random", - "name_normalized": "random", - "num_members": 4, - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Non-work banter and water cooler conversation" - }, - "unlinked": 0 - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "dGVhbTpDMDYxRkE1UEI=" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.list method", - "properties": { - "channels": { - "items": { - "$ref": "#/definitions/objs_conversation" - }, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "channels" - ], - "title": "conversations.list success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "missing_scope", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:read", - "groups:read", - "im:read", - "mpim:read" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.mark": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Sets the read cursor in a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.mark" - }, - "operationId": "conversations_mark", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Channel or conversation to set the read cursor for.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "Unique identifier of message you want marked as most recently seen in this conversation.", - "in": "formData", - "name": "ts", - "type": "number" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.mark method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.mark success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.mark method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "invalid_timestamp", - "not_in_channel", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "not_allowed_token_type" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.mark error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.members": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve members of a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.members" - }, - "operationId": "conversations_members", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "ID of the conversation to retrieve members for", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical paginated success response", - "examples": { - "application/json": { - "members": [ - "U023BECGF", - "U061F7AUR", - "W012A3CDE" - ], - "ok": true, - "response_metadata": { - "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.members method", - "properties": { - "members": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "members", - "response_metadata" - ], - "title": "conversations.members success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when an invalid cursor is provided", - "examples": { - "application/json": { - "error": "invalid_cursor", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response conversations.members method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "invalid_limit", - "invalid_cursor", - "fetch_members_failed", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.members error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:read", - "groups:read", - "im:read", - "mpim:read" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.open": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Opens or resumes a direct message or multi-person direct message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.open" - }, - "operationId": "conversations_open", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.", - "in": "formData", - "name": "users", - "type": "string" - }, - { - "description": "Boolean, indicates you want the full IM channel definition in the response.", - "in": "formData", - "name": "return_im", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": { - "id": "D069C7QFK" - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.open method when opening channels, ims, mpims", - "properties": { - "already_open": { - "type": "boolean" - }, - "channel": { - "items": [ - { - "$ref": "#/definitions/objs_conversation" - }, - { - "additionalProperties": false, - "properties": { - "created": { - "type": "string" - }, - "id": { - "$ref": "#/definitions/defs_dm_id" - }, - "is_im": { - "type": "boolean" - }, - "is_open": { - "type": "boolean" - }, - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest": { - "$ref": "#/definitions/objs_message" - }, - "unread_count": { - "type": "number" - }, - "unread_count_display": { - "type": "number" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - } - }, - "required": [ - "id" - ], - "type": "object" - } - ] - }, - "no_op": { - "type": "boolean" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.open success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.open method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "user_not_found", - "user_not_visible", - "user_disabled", - "users_list_not_supplied", - "not_enough_users", - "too_many_users", - "invalid_user_combination", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "channel_not_found" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.open error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.rename": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Renames a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.rename" - }, - "operationId": "conversations_rename", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of conversation to rename", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "New name for conversation.", - "in": "formData", - "name": "name", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "channel": { - "created": 1449252889, - "creator": "W012A3BCD", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_member": true, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_read_only": false, - "is_shared": false, - "last_read": "1502126650.228446", - "locale": "en-US", - "name": "general", - "name_normalized": "general", - "num_members": 23, - "pending_shared": [], - "previous_names": [ - "specifics", - "abstractions", - "etc" - ], - "purpose": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "This part of the workspace is for fun. Make fun here." - }, - "topic": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "For public discussion of generalities" - }, - "unlinked": 0 - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.rename method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.rename success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when the calling user is not a member of the conversation", - "examples": { - "application/json": { - "error": "not_in_channel", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.rename method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "user_is_restricted", - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "not_in_channel", - "not_authorized", - "invalid_name", - "name_taken", - "invalid_name_required", - "invalid_name_punctuation", - "invalid_name_maxlength", - "invalid_name_specials", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.rename error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.replies": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve a thread of messages posted to a conversation", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.replies" - }, - "operationId": "conversations_replies", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:history`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Conversation ID to fetch thread from.", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.", - "in": "query", - "name": "ts", - "type": "number" - }, - { - "description": "End of time range of messages to include in results.", - "in": "query", - "name": "latest", - "type": "number" - }, - { - "description": "Start of time range of messages to include in results.", - "in": "query", - "name": "oldest", - "type": "number" - }, - { - "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "in": "query", - "name": "inclusive", - "type": "boolean" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "has_more": true, - "messages": [ - { - "last_read": "1484678597.521003", - "reply_count": 3, - "subscribed": true, - "text": "island", - "thread_ts": "1482960137.003543", - "ts": "1482960137.003543", - "type": "message", - "unread_count": 0, - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "one island", - "thread_ts": "1482960137.003543", - "ts": "1483037603.017503", - "type": "message", - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "two island", - "thread_ts": "1482960137.003543", - "ts": "1483051909.018632", - "type": "message", - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "three for the land", - "thread_ts": "1482960137.003543", - "ts": "1483125339.020269", - "type": "message", - "user": "U061F7AUR" - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.replies method", - "properties": { - "has_more": { - "type": "boolean" - }, - "messages": { - "items": { - "items": [ - { - "additionalProperties": false, - "properties": { - "last_read": { - "$ref": "#/definitions/defs_ts" - }, - "latest_reply": { - "$ref": "#/definitions/defs_ts" - }, - "reply_count": { - "type": "integer" - }, - "reply_users": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "type": "array", - "uniqueItems": true - }, - "reply_users_count": { - "type": "integer" - }, - "source_team": { - "$ref": "#/definitions/defs_team" - }, - "subscribed": { - "type": "boolean" - }, - "team": { - "$ref": "#/definitions/defs_team" - }, - "text": { - "type": "string" - }, - "thread_ts": { - "$ref": "#/definitions/defs_ts" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - }, - "type": { - "type": "string" - }, - "unread_count": { - "type": "integer" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "user_profile": { - "$ref": "#/definitions/objs_user_profile_short" - }, - "user_team": { - "$ref": "#/definitions/defs_team" - } - }, - "required": [ - "type", - "user", - "text", - "thread_ts", - "reply_count", - "subscribed", - "ts" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "is_starred": { - "type": "boolean" - }, - "parent_user_id": { - "$ref": "#/definitions/defs_user_id" - }, - "source_team": { - "$ref": "#/definitions/defs_team" - }, - "team": { - "$ref": "#/definitions/defs_team" - }, - "text": { - "type": "string" - }, - "thread_ts": { - "$ref": "#/definitions/defs_ts" - }, - "ts": { - "$ref": "#/definitions/defs_ts" - }, - "type": { - "type": "string" - }, - "user": { - "$ref": "#/definitions/defs_user_id" - }, - "user_profile": { - "$ref": "#/definitions/objs_user_profile_short" - }, - "user_team": { - "$ref": "#/definitions/defs_team" - } - }, - "required": [ - "type", - "user", - "text", - "thread_ts", - "parent_user_id", - "ts" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "messages" - ], - "title": "conversations.replies success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "thread_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.replies method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "missing_scope", - "channel_not_found", - "thread_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.replies error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:history", - "groups:history", - "im:history", - "mpim:history" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.setPurpose": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Sets the purpose for a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.setPurpose" - }, - "operationId": "conversations_setPurpose", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Conversation to set the purpose of", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "A new, specialer purpose", - "in": "formData", - "name": "purpose", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.setPurpose method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.setPurpose success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.setPurpose method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "not_in_channel", - "is_archived", - "too_long", - "user_is_restricted", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.setPurpose error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.setTopic": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Sets the topic for a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.setTopic" - }, - "operationId": "conversations_setTopic", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "Conversation to set the topic of", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "The new topic string. Does not support formatting or linkification.", - "in": "formData", - "name": "topic", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.setTopic method", - "properties": { - "channel": { - "$ref": "#/definitions/objs_conversation" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.setTopic success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.setTopic method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "not_in_channel", - "is_archived", - "too_long", - "user_is_restricted", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.setTopic error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.unarchive": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Reverses conversation archival.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.unarchive" - }, - "operationId": "conversations_unarchive", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of conversation to unarchive", - "in": "formData", - "name": "channel", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.unarchive method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "conversations.unarchive success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from conversations.unarchive method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "channel_not_found", - "not_archived", - "not_authed", - "invalid_auth", - "account_inactive", - "user_is_bot", - "user_is_restricted", - "user_is_ultra_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "team_added_to_org", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "needed": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "provided": { - "type": "string" - } - }, - "required": [ - "ok", - "error" - ], - "title": "conversations.unarchive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/dialog.open": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Open a dialog with a user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dialog.open" - }, - "operationId": "dialog_open", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The dialog definition. This must be a JSON-encoded string.", - "in": "query", - "name": "dialog", - "required": true, - "type": "string" - }, - { - "description": "Exchange a trigger to post to the user.", - "in": "query", - "name": "trigger_id", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response is quite minimal.", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from dialog.open method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "dialog.open schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response, before getting to any possible validation errors.", - "examples": { - "application/json": { - "error": "missing_trigger", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from dialog.open method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "validation_errors", - "missing_trigger", - "missing_dialog", - "trigger_exchanged", - "trigger_expired", - "invalid_trigger", - "app_missing_action_url", - "cannot_create_dialog", - "failed_sending_dialog", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "dialog.open error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "dialog" - ] - } - }, - "/dnd.endDnd": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Ends the current user's Do Not Disturb session immediately.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.endDnd" - }, - "operationId": "dnd_endDnd", - "parameters": [ - { - "description": "Authentication token. Requires scope: `dnd:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from dnd.endDnd method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "dnd.endDnd schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from dnd.endDnd method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "unknown_error", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "dnd.endDnd error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "dnd:write" - ] - } - ], - "tags": [ - "dnd" - ] - } - }, - "/dnd.endSnooze": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Ends the current user's snooze mode immediately.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.endSnooze" - }, - "operationId": "dnd_endSnooze", - "parameters": [ - { - "description": "Authentication token. Requires scope: `dnd:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from dnd.endSnooze method", - "properties": { - "dnd_enabled": { - "type": "boolean" - }, - "next_dnd_end_ts": { - "type": "integer" - }, - "next_dnd_start_ts": { - "type": "integer" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "snooze_enabled": { - "type": "boolean" - } - }, - "required": [ - "ok", - "dnd_enabled", - "next_dnd_start_ts", - "next_dnd_end_ts", - "snooze_enabled" - ], - "title": "dnd.endSnooze schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from dnd.endSnooze method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "snooze_not_active", - "snooze_end_failed", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "dnd.endSnooze error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "dnd:write" - ] - } - ], - "tags": [ - "dnd" - ] - } - }, - "/dnd.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieves a user's current Do Not Disturb status.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.info" - }, - "operationId": "dnd_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `dnd:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "User to fetch status for (defaults to current user)", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from dnd.info method", - "properties": { - "dnd_enabled": { - "type": "boolean" - }, - "next_dnd_end_ts": { - "type": "integer" - }, - "next_dnd_start_ts": { - "type": "integer" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "snooze_enabled": { - "type": "boolean" - }, - "snooze_endtime": { - "type": "integer" - }, - "snooze_remaining": { - "type": "integer" - } - }, - "required": [ - "ok", - "dnd_enabled", - "next_dnd_start_ts", - "next_dnd_end_ts" - ], - "title": "dnd.info schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from dnd.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "user_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "dnd.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "dnd:read" - ] - } - ], - "tags": [ - "dnd" - ] - } - }, - "/dnd.setSnooze": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Turns on Do Not Disturb mode for the current user, or changes its duration.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.setSnooze" - }, - "operationId": "dnd_setSnooze", - "parameters": [ - { - "description": "Authentication token. Requires scope: `dnd:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Number of minutes, from now, to snooze until.", - "in": "formData", - "name": "num_minutes", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from dnd.setSnooze method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "snooze_enabled": { - "type": "boolean" - }, - "snooze_endtime": { - "type": "integer" - }, - "snooze_remaining": { - "type": "integer" - } - }, - "required": [ - "ok", - "snooze_enabled", - "snooze_endtime", - "snooze_remaining" - ], - "title": "dnd.setSnooze schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from dnd.setSnooze method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "missing_duration", - "snooze_failed", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "too_long", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "dnd.setSnooze error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "dnd:write" - ] - } - ], - "tags": [ - "dnd" - ] - } - }, - "/dnd.teamInfo": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieves the Do Not Disturb status for up to 50 users on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.teamInfo" - }, - "operationId": "dnd_teamInfo", - "parameters": [ - { - "description": "Authentication token. Requires scope: `dnd:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Comma-separated list of users to fetch Do Not Disturb status for", - "in": "query", - "name": "users", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "users": { - "U023BECGF": { - "dnd_enabled": true, - "next_dnd_end_ts": 1450423800, - "next_dnd_start_ts": 1450387800 - }, - "W058CJVAA": { - "dnd_enabled": false, - "next_dnd_end_ts": 1, - "next_dnd_start_ts": 1 - } - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "dnd:read" - ] - } - ], - "tags": [ - "dnd" - ] - } - }, - "/emoji.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists custom emoji for a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/emoji.list" - }, - "operationId": "emoji_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `emoji:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "emoji:read" - ] - } - ], - "tags": [ - "emoji" - ] - } - }, - "/files.comments.delete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deletes an existing comment on a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.comments.delete" - }, - "operationId": "files_comments_delete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:write:user`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "File to delete a comment from.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "The comment to delete.", - "in": "formData", - "name": "id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response is very simple", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response files.comments.delete method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "files.comments.delete schema", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when used with an invalid token", - "examples": { - "application/json": { - "error": "file_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response files.comments.delete method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "cant_delete", - "comment_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.comments.delete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:write:user" - ] - } - ], - "tags": [ - "files.comments", - "files" - ] - } - }, - "/files.delete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deletes a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.delete" - }, - "operationId": "files_delete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:write:user`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "ID of file to delete.", - "in": "formData", - "name": "file", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response files.delete method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "files.delete schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response files.delete method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "file_not_found", - "file_deleted", - "cant_delete_file", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.delete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:write:user" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/files.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets information about a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.info" - }, - "operationId": "files_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Specify a file by providing its ID.", - "in": "query", - "name": "file", - "type": "string" - }, - { - "in": "query", - "name": "count", - "type": "string" - }, - { - "in": "query", - "name": "page", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See [pagination](/docs/pagination) for more details.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "comments": [], - "file": { - "channels": [ - "C0T8SE4AU" - ], - "comments_count": 0, - "created": 1531763342, - "deanimate_gif": "https://.../tedair_deanimate_gif.png", - "display_as_bot": false, - "editable": false, - "external_type": "", - "filetype": "gif", - "groups": [], - "has_rich_preview": false, - "id": "F0S43PZDF", - "image_exif_rotation": 1, - "ims": [], - "is_external": false, - "is_public": true, - "is_starred": false, - "mimetype": "image/gif", - "mode": "hosted", - "name": "tedair.gif", - "original_h": 226, - "original_w": 176, - "permalink": "https://.../tedair.gif", - "permalink_public": "https://.../...", - "pjpeg": "https://.../tedair_pjpeg.jpg", - "pretty_type": "GIF", - "public_url_shared": false, - "shares": { - "public": { - "C0T8SE4AU": [ - { - "channel_name": "file-under", - "latest_reply": "1531763348.000001", - "reply_count": 1, - "reply_users": [ - "U061F7AUR" - ], - "reply_users_count": 1, - "team_id": "T061EG9R6", - "thread_ts": "1531763273.000015", - "ts": "1531763348.000001" - } - ] - } - }, - "size": 137531, - "thumb_160": "https://.../tedair_=_160.png", - "thumb_360": "https://.../tedair_360.png", - "thumb_360_gif": "https://.../tedair_360.gif", - "thumb_360_h": 226, - "thumb_360_w": 176, - "thumb_64": "https://.../tedair_64.png", - "thumb_80": "https://.../tedair_80.png", - "timestamp": 1531763342, - "title": "tedair.gif", - "url_private": "https://.../tedair.gif", - "url_private_download": "https://.../tedair.gif", - "user": "U061F7AUR", - "username": "" - }, - "ok": true, - "response_metadata": { - "next_cursor": "dGVhbTpDMUg5UkVTR0w=" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.info method", - "properties": { - "comments": { - "$ref": "#/definitions/objs_comments" - }, - "content_html": { - "type": "null" - }, - "editor": { - "$ref": "#/definitions/defs_user_id" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - }, - "response_metadata": { - "$ref": "#/definitions/objs_response_metadata" - } - }, - "required": [ - "ok", - "file", - "comments" - ], - "title": "files.info schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from files.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "file_not_found", - "file_deleted", - "timezone_count_failed", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:read" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/files.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List for a team, in a channel, or from a user with applied filters.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.list" - }, - "operationId": "files_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Filter files created by a single user.", - "in": "query", - "name": "user", - "type": "string" - }, - { - "description": "Filter files appearing in a specific channel, indicated by its ID.", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "Filter files created after this timestamp (inclusive).", - "in": "query", - "name": "ts_from", - "type": "number" - }, - { - "description": "Filter files created before this timestamp (inclusive).", - "in": "query", - "name": "ts_to", - "type": "number" - }, - { - "description": "Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.", - "in": "query", - "name": "types", - "type": "string" - }, - { - "in": "query", - "name": "count", - "type": "string" - }, - { - "in": "query", - "name": "page", - "type": "string" - }, - { - "description": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.", - "in": "query", - "name": "show_files_hidden_by_limit", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "files": [ - { - "channels": [ - "C0T8SE4AU" - ], - "comments_count": 0, - "created": 1531763254, - "deanimate_gif": "https://.../billair_deanimate_gif.png", - "display_as_bot": false, - "editable": false, - "external_type": "", - "filetype": "gif", - "groups": [], - "id": "F0S43P1CZ", - "image_exif_rotation": 1, - "ims": [], - "is_external": false, - "is_public": true, - "mimetype": "image/gif", - "mode": "hosted", - "name": "billair.gif", - "original_h": 226, - "original_w": 176, - "permalink": "https://.../billair.gif", - "permalink_public": "https://.../...", - "pjpeg": "https://.../billair_pjpeg.jpg", - "pretty_type": "GIF", - "public_url_shared": false, - "size": 144538, - "thumb_160": "https://.../billair_=_160.png", - "thumb_360": "https://.../billair_360.png", - "thumb_360_gif": "https://.../billair_360.gif", - "thumb_360_h": 226, - "thumb_360_w": 176, - "thumb_64": "https://.../billair_64.png", - "thumb_80": "https://.../billair_80.png", - "timestamp": 1531763254, - "title": "billair.gif", - "url_private": "https://.../billair.gif", - "url_private_download": "https://.../billair.gif", - "user": "U061F7AUR", - "username": "" - }, - { - "channels": [ - "C0T8SE4AU" - ], - "comments_count": 0, - "created": 1531763342, - "deanimate_gif": "https://.../tedair_deanimate_gif.png", - "display_as_bot": false, - "editable": false, - "external_type": "", - "filetype": "gif", - "groups": [], - "id": "F0S43PZDF", - "image_exif_rotation": 1, - "ims": [], - "is_external": false, - "is_public": true, - "mimetype": "image/gif", - "mode": "hosted", - "name": "tedair.gif", - "original_h": 226, - "original_w": 176, - "permalink": "https://.../tedair.gif", - "permalink_public": "https://.../...", - "pjpeg": "https://.../tedair_pjpeg.jpg", - "pretty_type": "GIF", - "public_url_shared": false, - "size": 137531, - "thumb_160": "https://.../tedair_=_160.png", - "thumb_360": "https://.../tedair_360.png", - "thumb_360_gif": "https://.../tedair_360.gif", - "thumb_360_h": 226, - "thumb_360_w": 176, - "thumb_64": "https://.../tedair_64.png", - "thumb_80": "https://.../tedair_80.png", - "timestamp": 1531763342, - "title": "tedair.gif", - "url_private": "https://.../tedair.gif", - "url_private_download": "https://.../tedair.gif", - "user": "U061F7AUR", - "username": "" - } - ], - "ok": true, - "paging": { - "count": 100, - "page": 1, - "pages": 1, - "total": 2 - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.list method", - "properties": { - "files": { - "items": { - "$ref": "#/definitions/objs_file" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - } - }, - "required": [ - "ok", - "files", - "paging" - ], - "title": "files.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from files.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "user_not_found", - "unknown_type", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:read" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/files.remote.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Adds a file from a remote service", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.add" - }, - "operationId": "files_remote_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:write`", - "in": "formData", - "name": "token", - "type": "string" - }, - { - "description": "Creator defined GUID for the file.", - "in": "formData", - "name": "external_id", - "type": "string" - }, - { - "description": "Title of the file being shared.", - "in": "formData", - "name": "title", - "type": "string" - }, - { - "description": "type of file", - "in": "formData", - "name": "filetype", - "type": "string" - }, - { - "description": "URL of the remote file.", - "in": "formData", - "name": "external_url", - "type": "string" - }, - { - "description": "Preview of the document via `multipart/form-data`.", - "in": "formData", - "name": "preview_image", - "type": "string" - }, - { - "description": "A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.", - "in": "formData", - "name": "indexable_file_contents", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:write" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve information about a remote file added to Slack", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.info" - }, - "operationId": "files_remote_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Specify a file by providing its ID.", - "in": "query", - "name": "file", - "type": "string" - }, - { - "description": "Creator defined GUID for the file.", - "in": "query", - "name": "external_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:read" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve information about a remote file added to Slack", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.list" - }, - "operationId": "files_remote_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Filter files appearing in a specific channel, indicated by its ID.", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "Filter files created after this timestamp (inclusive).", - "in": "query", - "name": "ts_from", - "type": "number" - }, - { - "description": "Filter files created before this timestamp (inclusive).", - "in": "query", - "name": "ts_to", - "type": "number" - }, - { - "description": "The maximum number of items to return.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:read" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Remove a remote file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.remove" - }, - "operationId": "files_remote_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:write`", - "in": "formData", - "name": "token", - "type": "string" - }, - { - "description": "Specify a file by providing its ID.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "Creator defined GUID for the file.", - "in": "formData", - "name": "external_id", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:write" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.share": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Share a remote file into a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.share" - }, - "operationId": "files_remote_share", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:share`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required.", - "in": "query", - "name": "file", - "type": "string" - }, - { - "description": "The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required.", - "in": "query", - "name": "external_id", - "type": "string" - }, - { - "description": "Comma-separated list of channel IDs where the file will be shared.", - "in": "query", - "name": "channels", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:share" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.update": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Updates an existing remote file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.update" - }, - "operationId": "files_remote_update", - "parameters": [ - { - "description": "Authentication token. Requires scope: `remote_files:write`", - "in": "formData", - "name": "token", - "type": "string" - }, - { - "description": "Specify a file by providing its ID.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "Creator defined GUID for the file.", - "in": "formData", - "name": "external_id", - "type": "string" - }, - { - "description": "Title of the file being shared.", - "in": "formData", - "name": "title", - "type": "string" - }, - { - "description": "type of file", - "in": "formData", - "name": "filetype", - "type": "string" - }, - { - "description": "URL of the remote file.", - "in": "formData", - "name": "external_url", - "type": "string" - }, - { - "description": "Preview of the document via `multipart/form-data`.", - "in": "formData", - "name": "preview_image", - "type": "string" - }, - { - "description": "File containing contents that can be used to improve searchability for the remote file.", - "in": "formData", - "name": "indexable_file_contents", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:write" - ] - } - ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.revokePublicURL": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Revokes public/external sharing access for a file", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.revokePublicURL" - }, - "operationId": "files_revokePublicURL", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:write:user`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "File to revoke", - "in": "formData", - "name": "file", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.revokePublicURL method", - "properties": { - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "file" - ], - "title": "files.revokePublicURL schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from files.revokePublicURL method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "file_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.revokePublicURL error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:write:user" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/files.sharedPublicURL": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Enables a file for public/external sharing.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.sharedPublicURL" - }, - "operationId": "files_sharedPublicURL", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:write:user`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "File to share", - "in": "formData", - "name": "file", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.sharedPublicURL method", - "properties": { - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "file" - ], - "title": "files.sharedPublicURL schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from files.sharedPublicURL method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "file_not_found", - "not_allowed", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.sharedPublicURL error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:write:user" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/files.upload": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Uploads or creates a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.upload" - }, - "operationId": "files_upload", - "parameters": [ - { - "description": "Authentication token. Requires scope: `files:write:user`", - "in": "formData", - "name": "token", - "type": "string" - }, - { - "description": "File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "File contents via a POST variable. If omitting this parameter, you must provide a `file`.", - "in": "formData", - "name": "content", - "type": "string" - }, - { - "description": "A [file type](/types/file#file_types) identifier.", - "in": "formData", - "name": "filetype", - "type": "string" - }, - { - "description": "Filename of file.", - "in": "formData", - "name": "filename", - "type": "string" - }, - { - "description": "Title of file.", - "in": "formData", - "name": "title", - "type": "string" - }, - { - "description": "The message text introducing the file in specified `channels`.", - "in": "formData", - "name": "initial_comment", - "type": "string" - }, - { - "description": "Comma-separated list of channel names or IDs where the file will be shared.", - "in": "formData", - "name": "channels", - "type": "string" - }, - { - "description": "Provide another message's `ts` value to upload this file as a reply. Never use a reply's `ts` value; use its parent instead.", - "in": "formData", - "name": "thread_ts", - "type": "number" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Success response after uploading a file to a channel with an initial message", - "examples": { - "application/json": { - "file": { - "channels": [], - "comments_count": 0, - "created": 1532293501, - "display_as_bot": false, - "editable": false, - "external_type": "", - "filetype": "gif", - "groups": [], - "has_rich_preview": false, - "id": "F0TD00400", - "image_exif_rotation": 1, - "ims": [ - "D0L4B9P0Q" - ], - "is_external": false, - "is_public": false, - "is_starred": false, - "mimetype": "image/jpeg", - "mode": "hosted", - "name": "dramacat.gif", - "original_h": 366, - "original_w": 526, - "permalink": "https://.../dramacat.gif", - "permalink_public": "https://.../More-Path-Components", - "pretty_type": "JPEG", - "public_url_shared": false, - "shares": { - "private": { - "D0L4B9P0Q": [ - { - "reply_count": 0, - "reply_users": [], - "reply_users_count": 0, - "ts": "1532293503.000001" - } - ] - } - }, - "size": 43518, - "thumb_160": "https://.../dramacat_160.gif", - "thumb_360": "https://.../dramacat_360.gif", - "thumb_360_h": 250, - "thumb_360_w": 360, - "thumb_480": "https://.../dramacat_480.gif", - "thumb_480_h": 334, - "thumb_480_w": 480, - "thumb_64": "https://.../dramacat_64.gif", - "thumb_80": "https://.../dramacat_80.gif", - "timestamp": 1532293501, - "title": "dramacat", - "url_private": "https://.../dramacat.gif", - "url_private_download": "https://.../dramacat.gif", - "user": "U0L4B9NSU", - "username": "" - }, - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response files.upload method", - "properties": { - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "file" - ], - "title": "files.upload schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response files.upload method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "posting_to_general_channel_denied", - "invalid_channel", - "file_uploads_disabled", - "file_uploads_except_images_disabled", - "storage_limit_reached", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "files.upload error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "files:write:user" - ] - } - ], - "tags": [ - "files" - ] - } - }, - "/migration.exchange": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "For Enterprise Grid workspaces, map local user IDs to global user IDs", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/migration.exchange" - }, - "operationId": "migration_exchange", - "parameters": [ - { - "description": "Authentication token. Requires scope: `tokens.basic`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A comma-separated list of user ids, up to 400 per request", - "in": "query", - "name": "users", - "required": true, - "type": "string" - }, - { - "description": "Specify team_id starts with `T` in case of Org Token", - "in": "query", - "name": "team_id", - "type": "string" - }, - { - "description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.", - "in": "query", - "name": "to_old", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response when mappings exist for the specified user IDs", - "examples": { - "application/json": { - "enterprise_id": "E1KQTNXE1", - "invalid_user_ids": [ - "U21ABZZXX" - ], - "ok": true, - "team_id": "T1KR7PE1W", - "user_id_map": { - "U06UBSUN5": "W06M56XJM", - "U06UBSVB3": "W06PUUDLY", - "U06UBSVDX": "W06PUUDMW", - "U06UEB62U": "W06PTT6GH", - "W06UAZ65Q": "W06UAZ65Q" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from migration.exchange method", - "properties": { - "enterprise_id": { - "title": "The enterprise grid organization ID containing the workspace/team.", - "type": "string" - }, - "invalid_user_ids": { - "items": { - "type": "string" - }, - "title": "A list of User IDs that cannot be mapped or found", - "type": "array" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team_id": { - "$ref": "#/definitions/defs_team" - }, - "user_id_map": { - "additionalProperties": true, - "title": "A mapping of provided user IDs with mapped user IDs", - "type": "object" - } - }, - "required": [ - "ok", - "team_id", - "enterprise_id" - ], - "title": "migration.exchange success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response when there are no mappings to provide", - "examples": { - "application/json": { - "error": "not_enterprise_team", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from migration.exchange method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_enterprise_team", - "too_many_users", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "migration.exchange error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "tokens.basic" - ] - } - ], - "tags": [ - "migration" - ] - } - }, - "/oauth.access": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Exchanges a temporary OAuth verifier code for an access token.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.access" - }, - "operationId": "oauth_access", - "parameters": [ - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_id", - "type": "string" - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_secret", - "type": "string" - }, - { - "description": "The `code` param returned via the OAuth callback.", - "in": "query", - "name": "code", - "type": "string" - }, - { - "description": "This must match the originally submitted URI (if one was sent).", - "in": "query", - "name": "redirect_uri", - "type": "string" - }, - { - "description": "Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).", - "in": "query", - "name": "single_channel", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successful user token negotiation for a single scope", - "examples": { - "application/json": { - "access_token": "xoxp-XXXXXXXX-XXXXXXXX-XXXXX", - "enterprise_id": null, - "scope": "groups:write", - "team_id": "TXXXXXXXXX", - "team_name": "Wyld Stallyns LLC" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_client_id", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "oauth" - ] - } - }, - "/oauth.token": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Exchanges a temporary OAuth verifier code for a workspace token.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.token" - }, - "operationId": "oauth_token", - "parameters": [ - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_id", - "type": "string" - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_secret", - "type": "string" - }, - { - "description": "The `code` param returned via the OAuth callback.", - "in": "query", - "name": "code", - "type": "string" - }, - { - "description": "This must match the originally submitted URI (if one was sent).", - "in": "query", - "name": "redirect_uri", - "type": "string" - }, - { - "description": "Request the user to add your app only to a single channel.", - "in": "query", - "name": "single_channel", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Success example using a workspace app produces a very different kind of response", - "examples": { - "application/json": { - "access_token": "xoxa-access-token-string", - "app_id": "A012345678", - "app_user_id": "U0AB12ABC", - "authorizing_user_id": "U0HTT3Q0G", - "installer_user_id": "U061F7AUR", - "ok": true, - "permissions": [ - { - "resource_id": 0, - "resource_type": "channel", - "scopes": [ - "channels:read", - "chat:write:user" - ] - } - ], - "single_channel_id": "C061EG9T2", - "team_id": "T061EG9Z9", - "team_name": "Subarachnoid Workspace", - "token_type": "app" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_client_id", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "oauth" - ] - } - }, - "/oauth.v2.access": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Exchanges a temporary OAuth verifier code for an access token.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.v2.access" - }, - "operationId": "oauth_v2_access", - "parameters": [ - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_id", - "type": "string" - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_secret", - "type": "string" - }, - { - "description": "The `code` param returned via the OAuth callback.", - "in": "query", - "name": "code", - "required": true, - "type": "string" - }, - { - "description": "This must match the originally submitted URI (if one was sent).", - "in": "query", - "name": "redirect_uri", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successful token request with scopes for both a bot user and a user token", - "examples": { - "application/json": { - "access_token": "xoxb-17653672481-19874698323-pdFZKVeTuE8sk7oOcBrzbqgy", - "app_id": "A0KRD7HC3", - "authed_user": { - "access_token": "xoxp-1234", - "id": "U1234", - "scope": "chat:write", - "token_type": "user" - }, - "bot_user_id": "U0KRQLJ9H", - "enterprise": { - "id": "E12345678", - "name": "slack-sports" - }, - "ok": true, - "scope": "commands,incoming-webhook", - "team": { - "id": "T9TK3CUKW", - "name": "Slack Softball Team" - }, - "token_type": "bot" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_client_id", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "oauth.v2", - "oauth" - ] - } - }, - "/pins.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Pins an item to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.add" - }, - "operationId": "pins_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `pins:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel to pin the item in.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Timestamp of the message to pin.", - "in": "formData", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from pins.add method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "pins.add schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "channel_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from pins.add method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "message_not_found", - "channel_not_found", - "no_item_specified", - "already_pinned", - "permission_denied", - "file_not_shared", - "not_pinnable", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "pins.add error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "pins:write" - ] - } - ], - "tags": [ - "pins" - ] - } - }, - "/pins.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists items pinned to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.list" - }, - "operationId": "pins_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `pins:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel to get pinned items for.", - "in": "query", - "name": "channel", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "items": [ - { - "channel": "C2U86NC6H", - "created": 1508881078, - "created_by": "U2U85N1RZ", - "message": { - "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151", - "pinned_to": [ - "C2U86NC6H" - ], - "text": "What is the meaning of life?", - "ts": "1508197641.000151", - "type": "message", - "user": "U2U85N1RZ" - }, - "type": "message" - }, - { - "channel": "C2U86NC6H", - "created": 1508880991, - "created_by": "U2U85N1RZ", - "message": { - "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015", - "pinned_to": [ - "C2U86NC6H" - ], - "text": "The meaning of life, the universe, and everything is 42.", - "ts": "1503289197.000015", - "type": "message", - "user": "U2U85N1RZ" - }, - "type": "message" - } - ], - "ok": true - } - }, - "schema": { - "description": "Schema for successful response from pins.list method", - "items": [ - { - "additionalProperties": false, - "properties": { - "items": { - "items": [ - { - "additionalProperties": false, - "properties": { - "created": { - "type": "integer" - }, - "created_by": { - "$ref": "#/definitions/defs_user_id" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "type": { - "enum": [ - "file" - ], - "type": "string" - } - }, - "title": "File Pin", - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "created": { - "type": "integer" - }, - "created_by": { - "$ref": "#/definitions/defs_user_id" - }, - "message": { - "$ref": "#/definitions/objs_message" - }, - "type": { - "enum": [ - "message" - ], - "type": "string" - } - }, - "title": "Message Pin", - "type": "object" - } - ], - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "items" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "count": { - "type": "integer" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok", - "count" - ], - "type": "object" - } - ], - "title": "pins.list success schema" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from pins.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "channel_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "pins.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "pins:read" - ] - } - ], - "tags": [ - "pins" - ] - } - }, - "/pins.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Un-pins an item from a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.remove" - }, - "operationId": "pins_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `pins:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel where the item is pinned to.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Timestamp of the message to un-pin.", - "in": "formData", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from pins.remove method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "pins.remove schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "no_pin", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from pins.remove method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "file_not_found", - "file_comment_not_found", - "message_not_found", - "no_item_specified", - "not_pinned", - "permission_denied", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_typ", - "missing_post_typ", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeou", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "pins.remove error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "pins:write" - ] - } - ], - "tags": [ - "pins" - ] - } - }, - "/reactions.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Adds a reaction to an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.add" - }, - "operationId": "reactions_add", - "parameters": [ - { - "description": "Channel where the message to add reaction to was posted.", - "in": "formData", - "name": "channel", - "required": true, - "type": "string" - }, - { - "description": "Reaction (emoji) name.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Timestamp of the message to add reaction to.", - "in": "formData", - "name": "timestamp", - "required": true, - "type": "string" - }, - { - "description": "Authentication token. Requires scope: `reactions:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reactions.add method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "reactions.add schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "already_reacted", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reactions.add method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "message_not_found", - "no_item_specified", - "invalid_name", - "already_reacted", - "too_many_emoji", - "too_many_reactions", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reactions.add error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reactions:write" - ] - } - ], - "tags": [ - "reactions" - ] - } - }, - "/reactions.get": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets reactions for an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.get" - }, - "operationId": "reactions_get", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reactions:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel where the message to get reactions for was posted.", - "in": "query", - "name": "channel", - "type": "string" - }, - { - "description": "File to get reactions for.", - "in": "query", - "name": "file", - "type": "string" - }, - { - "description": "File comment to get reactions for.", - "in": "query", - "name": "file_comment", - "type": "string" - }, - { - "description": "If true always return the complete reaction list.", - "in": "query", - "name": "full", - "type": "boolean" - }, - { - "description": "Timestamp of the message to get reactions for.", - "in": "query", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "file": { - "channels": [ - "C2U7V2YA2" - ], - "comments_count": 1, - "created": 1507850315, - "groups": [], - "id": "F7H0D7ZA4", - "ims": [], - "name": "computer.gif", - "reactions": [ - { - "count": 1, - "name": "stuck_out_tongue_winking_eye", - "users": [ - "U2U85N1RV" - ] - } - ], - "timestamp": 1507850315, - "title": "computer.gif", - "user": "U2U85N1RV" - }, - "ok": true, - "type": "file" - } - }, - "schema": { - "description": "Schema for successful response from reactions.get method", - "items": [ - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "message": { - "$ref": "#/definitions/objs_message" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "type": { - "enum": [ - "message" - ], - "type": "string" - } - }, - "required": [ - "ok", - "type", - "channel", - "message" - ] - }, - { - "additionalProperties": false, - "properties": { - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "type": { - "enum": [ - "file" - ], - "type": "string" - } - }, - "required": [ - "ok", - "type", - "file" - ] - }, - { - "additionalProperties": false, - "properties": { - "comment": { - "$ref": "#/definitions/objs_comment" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "type": { - "enum": [ - "file_comment" - ], - "type": "string" - } - }, - "required": [ - "ok", - "type", - "file", - "comment" - ] - } - ], - "title": "reactions.get success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reactions.get method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "file_not_found", - "file_comment_not_found", - "message_not_found", - "no_item_specified", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reactions.get error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reactions:read" - ] - } - ], - "tags": [ - "reactions" - ] - } - }, - "/reactions.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists reactions made by a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.list" - }, - "operationId": "reactions_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reactions:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Show reactions made by this user. Defaults to the authed user.", - "in": "query", - "name": "user", - "type": "string" - }, - { - "description": "If true always return the complete reaction list.", - "in": "query", - "name": "full", - "type": "boolean" - }, - { - "in": "query", - "name": "count", - "type": "integer" - }, - { - "in": "query", - "name": "page", - "type": "integer" - }, - { - "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more details.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "items": [ - { - "channel": "C3UKJTQAC", - "message": { - "bot_id": "B4VLRLMKJ", - "reactions": [ - { - "count": 1, - "name": "robot_face", - "users": [ - "U2U85N1RV" - ] - } - ], - "subtype": "bot_message", - "text": "Hello from Python! :tada:", - "ts": "1507849573.000090", - "username": "Shipit Notifications" - }, - "type": "message" - }, - { - "comment": { - "comment": "This is a file comment", - "created": 1508286096, - "id": "Fc7LP08P1U", - "reactions": [ - { - "count": 1, - "name": "white_check_mark", - "users": [ - "U2U85N1RV" - ] - } - ], - "timestamp": 1508286096, - "type": "file_comment", - "user": "U2U85N1RV" - }, - "file": { - "channels": [ - "C2U7V2YA2" - ], - "comments_count": 1, - "created": 1507850315, - "reactions": [ - { - "count": 1, - "name": "stuck_out_tongue_winking_eye", - "users": [ - "U2U85N1RV" - ] - } - ], - "title": "computer.gif", - "user": "U2U85N1RV", - "username": "" - } - }, - { - "file": { - "channels": [ - "C2U7V2YA2" - ], - "comments_count": 1, - "created": 1507850315, - "id": "F7H0D7ZA4", - "name": "computer.gif", - "reactions": [ - { - "count": 1, - "name": "stuck_out_tongue_winking_eye", - "users": [ - "U2U85N1RV" - ] - } - ], - "size": 1639034, - "title": "computer.gif", - "user": "U2U85N1RV", - "username": "" - }, - "type": "file" - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "dGVhbTpDMUg5UkVTR0w=" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reactions.list method", - "properties": { - "items": { - "items": { - "items": [ - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "message": { - "$ref": "#/definitions/objs_message" - }, - "type": { - "enum": [ - "message" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "message" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "file": { - "$ref": "#/definitions/objs_file" - }, - "type": { - "enum": [ - "file" - ], - "type": "string" - } - }, - "required": [ - "type", - "file" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "comment": { - "$ref": "#/definitions/objs_comment" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "type": { - "enum": [ - "file_comment" - ], - "type": "string" - } - }, - "required": [ - "type", - "file", - "comment" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - }, - "response_metadata": { - "$ref": "#/definitions/objs_response_metadata" - } - }, - "required": [ - "ok", - "items" - ], - "title": "reactions.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reactions.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "user_not_found", - "not_authed", - "invalid_auth", - "account_inactiv", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reactions.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reactions:read" - ] - } - ], - "tags": [ - "reactions" - ] - } - }, - "/reactions.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Removes a reaction from an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.remove" - }, - "operationId": "reactions_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reactions:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Reaction (emoji) name.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "File to remove reaction from.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "File comment to remove reaction from.", - "in": "formData", - "name": "file_comment", - "type": "string" - }, - { - "description": "Channel where the message to remove reaction from was posted.", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "Timestamp of the message to remove reaction from.", - "in": "formData", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reactions.remove method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "reactions.remove schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "no_reaction", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reactions.remove method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "file_not_found", - "file_comment_not_found", - "message_not_found", - "no_item_specified", - "invalid_name", - "no_reaction", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reactions.remove error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reactions:write" - ] - } - ], - "tags": [ - "reactions" - ] - } - }, - "/reminders.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Creates a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.add" - }, - "operationId": "reminders_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reminders:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "The content of the reminder", - "in": "formData", - "name": "text", - "required": true, - "type": "string" - }, - { - "description": "When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. \"in 15 minutes,\" or \"every Thursday\")", - "in": "formData", - "name": "time", - "required": true, - "type": "string" - }, - { - "description": "The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.", - "in": "formData", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reminders.add method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "reminder": { - "$ref": "#/definitions/objs_reminder" - } - }, - "required": [ - "ok", - "reminder" - ], - "title": "reminders.add schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reminders.add method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "cannot_parse", - "user_not_found", - "cannot_add_bot", - "cannot_add_slackbot", - "cannot_add_others", - "cannot_add_others_recurring", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reminders.add error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reminders:write" - ] - } - ], - "tags": [ - "reminders" - ] - } - }, - "/reminders.complete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Marks a reminder as complete.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.complete" - }, - "operationId": "reminders_complete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reminders:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "The ID of the reminder to be marked as complete", - "in": "formData", - "name": "reminder", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reminders.complete method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "reminders.complete schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reminders.complete method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_found", - "cannot_complete_recurring", - "cannot_complete_others", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reminders.complete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reminders:write" - ] - } - ], - "tags": [ - "reminders" - ] - } - }, - "/reminders.delete": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Deletes a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.delete" - }, - "operationId": "reminders_delete", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reminders:write`", - "in": "header", - "name": "token", - "type": "string" - }, - { - "description": "The ID of the reminder", - "in": "formData", - "name": "reminder", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reminders.delete method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "reminders.delete schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reminders.delete method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reminders.delete error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reminders:write" - ] - } - ], - "tags": [ - "reminders" - ] - } - }, - "/reminders.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets information about a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.info" - }, - "operationId": "reminders_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reminders:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "The ID of the reminder", - "in": "query", - "name": "reminder", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reminders.info method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "reminder": { - "$ref": "#/definitions/objs_reminder" - } - }, - "required": [ - "ok", - "reminder" - ], - "title": "reminders.info schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reminders.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reminders.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reminders:read" - ] - } - ], - "tags": [ - "reminders" - ] - } - }, - "/reminders.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists all reminders created by or for a given user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.list" - }, - "operationId": "reminders_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `reminders:read`", - "in": "query", - "name": "token", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reminders.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "reminders": { - "items": { - "$ref": "#/definitions/objs_reminder" - }, - "type": "array" - } - }, - "required": [ - "ok", - "reminders" - ], - "title": "reminders.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from reminders.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "reminders.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "reminders:read" - ] - } - ], - "tags": [ - "reminders" - ] - } - }, - "/rtm.connect": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Starts a Real Time Messaging session.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/rtm.connect" - }, - "operationId": "rtm_connect", - "parameters": [ - { - "description": "Authentication token. Requires scope: `rtm:stream`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).", - "in": "query", - "name": "batch_presence_aware", - "type": "boolean" - }, - { - "description": "Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).", - "in": "query", - "name": "presence_sub", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "self": { - "id": "U4X318ZMZ", - "name": "robotoverlord" - }, - "team": { - "domain": "slackdemo", - "id": "T2U81E2FP", - "name": "SlackDemo" - }, - "url": "wss://..." - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from rtm.connect method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "self": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name" - ], - "type": "object" - }, - "team": { - "additionalProperties": false, - "properties": { - "domain": { - "type": "string" - }, - "id": { - "$ref": "#/definitions/defs_team" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "domain" - ], - "type": "object" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "required": [ - "ok", - "url", - "team", - "self" - ], - "title": "rtm.connect schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from rtm.connect method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "rtm.connect error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "rtm:stream" - ] - } - ], - "tags": [ - "rtm" - ] - } - }, - "/search.messages": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Searches for messages matching a query.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/search.messages" - }, - "operationId": "search_messages", - "parameters": [ - { - "description": "Authentication token. Requires scope: `search:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Pass the number of results you want per \"page\". Maximum of `100`.", - "in": "query", - "name": "count", - "type": "integer" - }, - { - "description": "Pass a value of `true` to enable query highlight markers (see below).", - "in": "query", - "name": "highlight", - "type": "boolean" - }, - { - "in": "query", - "name": "page", - "type": "integer" - }, - { - "description": "Search query.", - "in": "query", - "name": "query", - "required": true, - "type": "string" - }, - { - "description": "Return matches sorted by either `score` or `timestamp`.", - "in": "query", - "name": "sort", - "type": "string" - }, - { - "description": "Change sort direction to ascending (`asc`) or descending (`desc`).", - "in": "query", - "name": "sort_dir", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "messages": { - "matches": [ - { - "channel": { - "id": "C12345678", - "is_ext_shared": false, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "general", - "pending_shared": [] - }, - "iid": "cb64bdaa-c1e8-4631-8a91-0f78080113e9", - "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508284197000015", - "team": "T12345678", - "text": "The meaning of life the universe and everything is 42.", - "ts": "1508284197.000015", - "type": "message", - "user": "U2U85N1RV", - "username": "roach" - }, - { - "channel": { - "id": "C12345678", - "is_ext_shared": false, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "random", - "pending_shared": [] - }, - "iid": "9a00d3c9-bd2d-45b0-988b-6cff99ae2a90", - "permalink": "https://hitchhikers.slack.com/archives/C12345678/p1508795665000236", - "team": "T12345678", - "text": "The meaning of life the universe and everything is 101010", - "ts": "1508795665.000236", - "type": "message", - "user": "", - "username": "robot overlord" - } - ], - "pagination": { - "first": 1, - "last": 2, - "page": 1, - "page_count": 1, - "per_page": 20, - "total_count": 2 - }, - "paging": { - "count": 20, - "page": 1, - "pages": 1, - "total": 2 - }, - "total": 2 - }, - "ok": true, - "query": "The meaning of life the universe and everything" - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "No query passed", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "search:read" - ] - } - ], - "tags": [ - "search" - ] - } - }, - "/stars.add": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Adds a star to an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.add" - }, - "operationId": "stars_add", - "parameters": [ - { - "description": "Authentication token. Requires scope: `stars:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`).", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "File to add star to.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "File comment to add star to.", - "in": "formData", - "name": "file_comment", - "type": "string" - }, - { - "description": "Timestamp of the message to add star to.", - "in": "formData", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from stars.add method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "stars.add schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from stars.add method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "message_not_found", - "file_not_found", - "file_comment_not_found", - "channel_not_found", - "no_item_specified", - "already_starred", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "stars.add error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "stars:write" - ] - } - ], - "tags": [ - "stars" - ] - } - }, - "/stars.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists stars for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.list" - }, - "operationId": "stars_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `stars:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "in": "query", - "name": "count", - "type": "string" - }, - { - "in": "query", - "name": "page", - "type": "string" - }, - { - "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more details.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.", - "in": "query", - "name": "limit", - "type": "integer" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from stars.list method", - "properties": { - "items": { - "items": { - "items": [ - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "date_create": { - "type": "integer" - }, - "message": { - "$ref": "#/definitions/objs_message" - }, - "type": { - "enum": [ - "message" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "message", - "date_create" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "date_create": { - "type": "integer" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "type": { - "enum": [ - "file" - ], - "type": "string" - } - }, - "required": [ - "type", - "file", - "date_create" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "comment": { - "$ref": "#/definitions/objs_comment" - }, - "date_create": { - "type": "integer" - }, - "file": { - "$ref": "#/definitions/objs_file" - }, - "type": { - "enum": [ - "file_comment" - ], - "type": "string" - } - }, - "required": [ - "type", - "file", - "comment", - "date_create" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "date_create": { - "type": "integer" - }, - "type": { - "enum": [ - "channel" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "date_create" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_dm_id" - }, - "date_create": { - "type": "integer" - }, - "type": { - "enum": [ - "im" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "date_create" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/definitions/defs_group_id" - }, - "date_create": { - "type": "integer" - }, - "type": { - "enum": [ - "group" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "date_create" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - } - }, - "required": [ - "ok", - "items" - ], - "title": "stars.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from stars.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "stars.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "stars:read" - ] - } - ], - "tags": [ - "stars" - ] - } - }, - "/stars.remove": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Removes a star from an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.remove" - }, - "operationId": "stars_remove", - "parameters": [ - { - "description": "Authentication token. Requires scope: `stars:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`).", - "in": "formData", - "name": "channel", - "type": "string" - }, - { - "description": "File to remove star from.", - "in": "formData", - "name": "file", - "type": "string" - }, - { - "description": "File comment to remove star from.", - "in": "formData", - "name": "file_comment", - "type": "string" - }, - { - "description": "Timestamp of the message to remove star from.", - "in": "formData", - "name": "timestamp", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from stars.remove method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "stars.remove schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from stars.remove method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "bad_timestamp", - "message_not_found", - "file_not_found", - "file_comment_not_found", - "channel_not_found", - "no_item_specified", - "not_starred", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "stars.remove error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "stars:write" - ] - } - ], - "tags": [ - "stars" - ] - } - }, - "/team.accessLogs": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets the access logs for the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.accessLogs" - }, - "operationId": "team_accessLogs", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "End of time range of logs to include in results (inclusive).", - "in": "query", - "name": "before", - "type": "string" - }, - { - "in": "query", - "name": "count", - "type": "string" - }, - { - "in": "query", - "name": "page", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "This response demonstrates pagination and two access log entries.", - "examples": { - "application/json": { - "logins": [ - { - "count": 1, - "country": "US", - "date_first": 1422922864, - "date_last": 1422922864, - "ip": "127.0.0.1", - "isp": "BigCo ISP", - "region": "CA", - "user_agent": "SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36", - "user_id": "U45678", - "username": "alice" - }, - { - "count": 1, - "country": "US", - "date_first": 1422922493, - "date_last": 1422922493, - "ip": "127.0.0.1", - "isp": "BigCo ISP", - "region": "CA", - "user_agent": "SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4", - "user_id": "U12345", - "username": "white_rabbit" - } - ], - "ok": true, - "paging": { - "count": 100, - "page": 1, - "pages": 1, - "total": 2 - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.accessLogs method", - "properties": { - "logins": { - "items": { - "additionalProperties": false, - "properties": { - "count": { - "type": "integer" - }, - "country": { - "type": [ - "string", - "null" - ] - }, - "date_first": { - "type": "integer" - }, - "date_last": { - "type": "integer" - }, - "ip": { - "type": [ - "string", - "null" - ] - }, - "isp": { - "type": [ - "string", - "null" - ] - }, - "region": { - "type": [ - "string", - "null" - ] - }, - "user_agent": { - "type": "string" - }, - "user_id": { - "$ref": "#/definitions/defs_user_id" - }, - "username": { - "type": "string" - } - }, - "required": [ - "user_id", - "username", - "date_first", - "date_last", - "count", - "ip", - "user_agent", - "isp", - "country", - "region" - ], - "type": "object" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - } - }, - "required": [ - "ok", - "logins", - "paging" - ], - "title": "team.accessLogs schema", - "type": "object" - } - }, - "default": { - "description": "A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:", - "examples": { - "application/json": { - "error": "paid_only", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from team.accessLogs method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "paid_only", - "over_pagination_limit", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "team.accessLogs error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin" - ] - } - ], - "tags": [ - "team" - ] - } - }, - "/team.billableInfo": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets billable users information for the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.billableInfo" - }, - "operationId": "team_billableInfo", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A user to retrieve the billable information for. Defaults to all users.", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "billable_info": { - "U02UCPE1R": { - "billing_active": true - }, - "U02UEBSD2": { - "billing_active": true - }, - "U0632EWRW": { - "billing_active": false - } - }, - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin" - ] - } - ], - "tags": [ - "team" - ] - } - }, - "/team.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets information about the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.info" - }, - "operationId": "team_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `team:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels", - "in": "query", - "name": "team", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "team": { - "domain": "example", - "email_domain": "example.com", - "enterprise_id": "E1234A12AB", - "enterprise_name": "Umbrella Corporation", - "icon": { - "image_102": "https://...", - "image_132": "https://...", - "image_34": "https://...", - "image_44": "https://...", - "image_68": "https://...", - "image_88": "https://...", - "image_default": true - }, - "id": "T12345", - "name": "My Team" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.info method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "$ref": "#/definitions/objs_team" - } - }, - "required": [ - "ok", - "team" - ], - "title": "team.info schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from team.info method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "team.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "team:read" - ] - } - ], - "tags": [ - "team" - ] - } - }, - "/team.integrationLogs": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets the integration logs for the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.integrationLogs" - }, - "operationId": "team_integrationLogs", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Filter logs to this Slack app. Defaults to all logs.", - "in": "query", - "name": "app_id", - "type": "string" - }, - { - "description": "Filter logs with this change type. Defaults to all logs.", - "in": "query", - "name": "change_type", - "type": "string" - }, - { - "in": "query", - "name": "count", - "type": "string" - }, - { - "in": "query", - "name": "page", - "type": "string" - }, - { - "description": "Filter logs to this service. Defaults to all logs.", - "in": "query", - "name": "service_id", - "type": "string" - }, - { - "description": "Filter logs generated by this user\u2019s actions. Defaults to all logs.", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.integrationLogs method", - "properties": { - "logs": { - "items": { - "additionalProperties": false, - "properties": { - "admin_app_id": { - "$ref": "#/definitions/defs_app_id" - }, - "app_id": { - "$ref": "#/definitions/defs_app_id" - }, - "app_type": { - "type": "string" - }, - "change_type": { - "type": "string" - }, - "channel": { - "$ref": "#/definitions/defs_channel" - }, - "date": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "service_id": { - "type": "string" - }, - "service_type": { - "type": "string" - }, - "user_id": { - "$ref": "#/definitions/defs_user_id" - }, - "user_name": { - "type": "string" - } - }, - "required": [ - "user_id", - "user_name", - "date", - "change_type", - "app_type", - "app_id", - "scope" - ], - "type": "object" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "paging": { - "$ref": "#/definitions/objs_paging" - } - }, - "required": [ - "ok", - "logs", - "paging" - ], - "title": "team.integrationLogs schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from team.integrationLogs method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "team.integrationLogs error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "admin" - ] - } - ], - "tags": [ - "team" - ] - } - }, - "/team.profile.get": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieve a team's profile.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.profile.get" - }, - "operationId": "team_profile_get", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users.profile:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Filter by visibility.", - "in": "query", - "name": "visibility", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "profile": { - "fields": [ - { - "hint": "Enter the extension to reach your desk", - "id": "Xf06054AAA", - "is_hidden": 1, - "label": "Phone extension", - "options": null, - "ordering": 0, - "possible_values": null, - "type": "text" - }, - { - "hint": "When you were born", - "id": "Xf06054BBB", - "label": "Date of birth", - "options": null, - "ordering": 1, - "possible_values": null, - "type": "date" - }, - { - "hint": "Enter a link to your Facebook profile", - "id": "Xf06054CCC", - "label": "Facebook", - "options": null, - "ordering": 2, - "possible_values": null, - "type": "link" - }, - { - "hint": "Hogwarts, obviously", - "id": "Xf06054DDD", - "label": "House", - "options": null, - "ordering": 3, - "possible_values": [ - "Gryffindor", - "Hufflepuff", - "Ravenclaw", - "Slytherin" - ], - "type": "options_list" - }, - { - "hint": "Office location (LDAP)", - "id": "Xf06054EEE", - "label": "Location", - "options": { - "is_protected": 1 - }, - "ordering": 4, - "possible_values": null, - "type": "text" - }, - { - "hint": "The boss", - "id": "Xf06054FFF", - "label": "Manager", - "options": null, - "ordering": 5, - "possible_values": null, - "type": "user" - } - ] - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.profile.get method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "profile": { - "additionalProperties": false, - "properties": { - "fields": { - "items": { - "$ref": "#/definitions/objs_team_profile_field" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fields" - ], - "type": "object" - } - }, - "required": [ - "ok", - "profile" - ], - "title": "team.profile.get success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from team.profile.get method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_typ", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeou", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "team.profile.get error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users.profile:read" - ] - } - ], - "tags": [ - "team.profile", - "team" - ] - } - }, - "/usergroups.create": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Create a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.create" - }, - "operationId": "usergroups_create", - "parameters": [ - { - "description": "Authentication token. Requires scope: `usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", - "in": "formData", - "name": "channels", - "type": "string" - }, - { - "description": "A short description of the User Group.", - "in": "formData", - "name": "description", - "type": "string" - }, - { - "description": "A mention handle. Must be unique among channels, users and User Groups.", - "in": "formData", - "name": "handle", - "type": "string" - }, - { - "description": "Include the number of users in each User Group.", - "in": "formData", - "name": "include_count", - "type": "boolean" - }, - { - "description": "A name for the User Group. Must be unique among User Groups.", - "in": "formData", - "name": "name", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.create method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroup": { - "$ref": "#/definitions/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.create schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.create method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "permission_denied", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.create error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:write" - ] - } - ], - "tags": [ - "usergroups" - ] - } - }, - "/usergroups.disable": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Disable an existing User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.disable" - }, - "operationId": "usergroups_disable", - "parameters": [ - { - "description": "Authentication token. Requires scope: `usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include the number of users in the User Group.", - "in": "formData", - "name": "include_count", - "type": "boolean" - }, - { - "description": "The encoded ID of the User Group to disable.", - "in": "formData", - "name": "usergroup", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.disable method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroup": { - "$ref": "#/definitions/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.disable schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.disable method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "permission_denied", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.disable error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:write" - ] - } - ], - "tags": [ - "usergroups" - ] - } - }, - "/usergroups.enable": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Enable a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.enable" - }, - "operationId": "usergroups_enable", - "parameters": [ - { - "description": "Authentication token. Requires scope: `usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include the number of users in the User Group.", - "in": "formData", - "name": "include_count", - "type": "boolean" - }, - { - "description": "The encoded ID of the User Group to enable.", - "in": "formData", - "name": "usergroup", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.enable method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroup": { - "$ref": "#/definitions/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.enable schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.enable method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_require", - "fatal_error", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.enable error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:write" - ] - } - ], - "tags": [ - "usergroups" - ] - } - }, - "/usergroups.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all User Groups for a team", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.list" - }, - "operationId": "usergroups_list", - "parameters": [ - { - "description": "Include the list of users for each User Group.", - "in": "query", - "name": "include_users", - "type": "boolean" - }, - { - "description": "Authentication token. Requires scope: `usergroups:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include the number of users in each User Group.", - "in": "query", - "name": "include_count", - "type": "boolean" - }, - { - "description": "Include disabled User Groups.", - "in": "query", - "name": "include_disabled", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "usergroups": [ - { - "auto_type": "admin", - "created_by": "USLACKBOT", - "date_create": 1446598059, - "date_delete": 0, - "date_update": 1446670362, - "deleted_by": null, - "description": "A group of all Administrators on your team.", - "handle": "admins", - "id": "S0614TZR7", - "is_external": false, - "is_usergroup": true, - "name": "Team Admins", - "prefs": { - "channels": [], - "groups": [] - }, - "team_id": "T060RNRCH", - "updated_by": "U060RNRCZ", - "user_count": "2" - }, - { - "auto_type": "owner", - "created_by": "USLACKBOT", - "date_create": 1446678371, - "date_delete": 0, - "date_update": 1446678371, - "deleted_by": null, - "description": "A group of all Owners on your team.", - "handle": "owners", - "id": "S06158AV7", - "is_external": false, - "is_usergroup": true, - "name": "Team Owners", - "prefs": { - "channels": [], - "groups": [] - }, - "team_id": "T060RNRCH", - "updated_by": "USLACKBOT", - "user_count": "1" - }, - { - "auto_type": null, - "created_by": "U060RNRCZ", - "date_create": 1446746793, - "date_delete": 1446748865, - "date_update": 1446747767, - "deleted_by": null, - "description": "Marketing gurus, PR experts and product advocates.", - "handle": "marketing-team", - "id": "S0615G0KT", - "is_external": false, - "is_usergroup": true, - "name": "Marketing Team", - "prefs": { - "channels": [], - "groups": [] - }, - "team_id": "T060RNRCH", - "updated_by": "U060RNRCZ", - "user_count": "0" - } - ] - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroups": { - "items": { - "$ref": "#/definitions/objs_subteam" - }, - "type": "array" - } - }, - "required": [ - "ok", - "usergroups" - ], - "title": "usergroups.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_require", - "fatal_error", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:read" - ] - } - ], - "tags": [ - "usergroups" - ] - } - }, - "/usergroups.update": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Update an existing User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.update" - }, - "operationId": "usergroups_update", - "parameters": [ - { - "description": "A mention handle. Must be unique among channels, users and User Groups.", - "in": "formData", - "name": "handle", - "type": "string" - }, - { - "description": "A short description of the User Group.", - "in": "formData", - "name": "description", - "type": "string" - }, - { - "description": "A comma separated string of encoded channel IDs for which the User Group uses as a default.", - "in": "formData", - "name": "channels", - "type": "string" - }, - { - "description": "Authentication token. Requires scope: `usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include the number of users in the User Group.", - "in": "formData", - "name": "include_count", - "type": "boolean" - }, - { - "description": "The encoded ID of the User Group to update.", - "in": "formData", - "name": "usergroup", - "required": true, - "type": "string" - }, - { - "description": "A name for the User Group. Must be unique among User Groups.", - "in": "formData", - "name": "name", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "usergroup": { - "auto_type": null, - "created_by": "U060R4BJ4", - "date_create": 1447096577, - "date_delete": 0, - "date_update": 1447102109, - "deleted_by": null, - "description": "Marketing gurus, PR experts and product advocates.", - "handle": "marketing-team", - "id": "S0616NG6M", - "is_external": false, - "is_usergroup": true, - "name": "Marketing Team", - "prefs": { - "channels": [], - "groups": [] - }, - "team_id": "T060R4BHN", - "updated_by": "U060R4BJ4", - "user_count": 1, - "users": [ - "U060R4BJ4", - "U060RNRCZ" - ] - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.update method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroup": { - "$ref": "#/definitions/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.update schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.update method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "permission_denied", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_require", - "fatal_error", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.update error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:write" - ] - } - ], - "tags": [ - "usergroups" - ] - } - }, - "/usergroups.users.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List all users in a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.users.list" - }, - "operationId": "usergroups_users_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `usergroups:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Allow results that involve disabled User Groups.", - "in": "query", - "name": "include_disabled", - "type": "boolean" - }, - { - "description": "The encoded ID of the User Group to update.", - "in": "query", - "name": "usergroup", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Standard success response when used with a user token", - "examples": { - "application/json": { - "ok": true, - "users": [ - "U060R4BJ4", - "W123A4BC5" - ] - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.users.list method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "users": { - "items": { - "$ref": "#/definitions/defs_user_id" - }, - "type": "array" - } - }, - "required": [ - "ok", - "users" - ], - "title": "usergroups.users.list schema", - "type": "object" - } - }, - "default": { - "description": "Standard failure response when used with an invalid token", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.users.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_require", - "fatal_error", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.users.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:read" - ] - } - ], - "tags": [ - "usergroups.users", - "usergroups" - ] - } - }, - "/usergroups.users.update": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Update the list of users for a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.users.update" - }, - "operationId": "usergroups_users_update", - "parameters": [ - { - "description": "Authentication token. Requires scope: `usergroups:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include the number of users in the User Group.", - "in": "formData", - "name": "include_count", - "type": "boolean" - }, - { - "description": "The encoded ID of the User Group to update.", - "in": "formData", - "name": "usergroup", - "required": true, - "type": "string" - }, - { - "description": "A comma separated string of encoded user IDs that represent the entire list of users for the User Group.", - "in": "formData", - "name": "users", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "usergroup": { - "auto_type": null, - "created_by": "U060R4BJ4", - "date_create": 1447096577, - "date_delete": 0, - "date_update": 1447102109, - "deleted_by": null, - "description": "Marketing gurus, PR experts and product advocates.", - "handle": "marketing-team", - "id": "S0616NG6M", - "is_external": false, - "is_usergroup": true, - "name": "Marketing Team", - "prefs": { - "channels": [], - "groups": [] - }, - "team_id": "T060R4BHN", - "updated_by": "U060R4BJ4", - "user_count": 1, - "users": [ - "U060R4BJ4", - "U060RNRCZ" - ] - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.users.update method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "usergroup": { - "$ref": "#/definitions/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.users.update schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from usergroups.users.update method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "permission_denied", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "user_is_restricted", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_require", - "fatal_error", - "missing_charset", - "superfluous_charset" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "usergroups.users.update error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "usergroups:write" - ] - } - ], - "tags": [ - "usergroups.users", - "usergroups" - ] - } - }, - "/users.conversations": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "List conversations the calling user may access.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.conversations" - }, - "operationId": "users_conversations", - "parameters": [ - { - "description": "Authentication token. Requires scope: `conversations:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", - "in": "query", - "name": "user", - "type": "string" - }, - { - "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "in": "query", - "name": "types", - "type": "string" - }, - { - "description": "Set to `true` to exclude archived channels from the list", - "in": "query", - "name": "exclude_archived", - "type": "boolean" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.", - "examples": { - "application/json": { - "channels": [ - { - "created": 1449252889, - "creator": "U012A3CDE", - "id": "C012AB3CD", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": true, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "general", - "name_normalized": "general", - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "This channel is for team-wide communication and announcements. All team members are in this channel." - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Company-wide announcements and work-based matters" - }, - "unlinked": 0 - }, - { - "created": 1449252889, - "creator": "U061F7AUR", - "id": "C061EG9T2", - "is_archived": false, - "is_channel": true, - "is_ext_shared": false, - "is_general": false, - "is_group": false, - "is_im": false, - "is_mpim": false, - "is_org_shared": false, - "is_pending_ext_shared": false, - "is_private": false, - "is_shared": false, - "name": "random", - "name_normalized": "random", - "pending_shared": [], - "previous_names": [], - "purpose": { - "creator": "", - "last_set": 0, - "value": "A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels." - }, - "topic": { - "creator": "", - "last_set": 0, - "value": "Non-work banter and water cooler conversation" - }, - "unlinked": 0 - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "dGVhbTpDMDYxRkE1UEI=" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`", - "properties": { - "channels": { - "items": { - "$ref": "#/definitions/objs_conversation" - }, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "channels" - ], - "title": "users.conversations success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.conversations method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "method_not_supported_for_channel_type", - "missing_scope", - "invalid_types", - "invalid_cursor", - "invalid_limit", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.conversations error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "channels:read", - "groups:read", - "im:read", - "mpim:read" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.deletePhoto": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Delete the user profile photo", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.deletePhoto" - }, - "operationId": "users_deletePhoto", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users.profile:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.deletePhoto method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "users.deletePhoto schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.deletePhoto method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.deletePhoto error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users.profile:write" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.getPresence": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets user presence information.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.getPresence" - }, - "operationId": "users_getPresence", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "User to get presence info on. Defaults to the authed user.", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`).", - "examples": { - "application/json": { - "ok": true, - "presence": "active" - } - }, - "schema": { - "additionalProperties": true, - "description": "Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65", - "properties": { - "auto_away": { - "type": "boolean" - }, - "connection_count": { - "type": "integer" - }, - "last_activity": { - "type": "integer" - }, - "manual_away": { - "type": "boolean" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "online": { - "type": "boolean" - }, - "presence": { - "type": "string" - } - }, - "required": [ - "ok", - "presence" - ], - "title": "API method: users.getPresence", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": { - "type": "object" - }, - "description": "Schema for error response users.getPresence method", - "properties": { - "error": { - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.counts error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:read" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.identity": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Get a user's identity.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.identity" - }, - "operationId": "users_identity", - "parameters": [ - { - "description": "Authentication token. Requires scope: `identity.basic`", - "in": "query", - "name": "token", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "You will receive at a minimum the following information:", - "examples": { - "application/json": { - "ok": true, - "team": { - "id": "T0G9PQBBK" - }, - "user": { - "id": "U0G9QF9C6", - "name": "Sonny Whether" - } - } - }, - "schema": { - "description": "Schema for successful response from users.identity method", - "items": [ - { - "additionalProperties": false, - "description": "Schema for 'identity.basic' scope", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_team" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "user": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name", - "id" - ], - "type": "object" - } - }, - "required": [ - "ok", - "user", - "team" - ], - "type": "object" - }, - { - "additionalProperties": false, - "description": "Schema for 'identity.basic,identity.email' scopes", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_team" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "user": { - "additionalProperties": false, - "properties": { - "email": { - "format": "email", - "type": "string" - }, - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name", - "id", - "email" - ], - "type": "object" - } - }, - "required": [ - "ok", - "user", - "team" - ], - "type": "object" - }, - { - "additionalProperties": false, - "description": "Schema for 'identity.basic,identity.avatar' scopes", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_team" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "user": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "image_192": { - "format": "url", - "type": "string" - }, - "image_24": { - "format": "url", - "type": "string" - }, - "image_32": { - "format": "url", - "type": "string" - }, - "image_48": { - "format": "url", - "type": "string" - }, - "image_512": { - "format": "url", - "type": "string" - }, - "image_72": { - "format": "url", - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name", - "id", - "image_24", - "image_32", - "image_48", - "image_72", - "image_192", - "image_512" - ], - "type": "object" - } - }, - "required": [ - "ok", - "user", - "team" - ], - "type": "object" - }, - { - "additionalProperties": false, - "description": "Schema for 'identity.basic,identity.team' scopes", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "team": { - "additionalProperties": false, - "properties": { - "domain": { - "type": "string" - }, - "id": { - "$ref": "#/definitions/defs_team" - }, - "image_102": { - "format": "url", - "type": "string" - }, - "image_132": { - "format": "url", - "type": "string" - }, - "image_230": { - "format": "url", - "type": "string" - }, - "image_34": { - "format": "url", - "type": "string" - }, - "image_44": { - "format": "url", - "type": "string" - }, - "image_68": { - "format": "url", - "type": "string" - }, - "image_88": { - "format": "url", - "type": "string" - }, - "image_default": { - "type": "boolean" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "domain", - "image_34", - "image_44", - "image_68", - "image_88", - "image_102", - "image_132", - "image_230", - "image_default" - ], - "type": "object" - }, - "user": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/definitions/defs_user_id" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name", - "id" - ], - "type": "object" - } - }, - "required": [ - "ok", - "user", - "team" - ], - "type": "object" - } - ], - "title": "users.identity schema" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "account_inactive", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.identity method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.identity error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "identity.basic" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.info": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Gets information about a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.info" - }, - "operationId": "users_info", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Set this to `true` to receive the locale for this user. Defaults to `false`", - "in": "query", - "name": "include_locale", - "type": "boolean" - }, - { - "description": "User to get info on", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "user": { - "color": "9f69e7", - "deleted": false, - "has_2fa": false, - "id": "W012A3CDE", - "is_admin": true, - "is_app_user": false, - "is_bot": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "name": "spengler", - "profile": { - "avatar_hash": "ge3b51ca72de", - "display_name": "spengler", - "display_name_normalized": "spengler", - "email": "spengler@ghostbusters.example.com", - "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_original": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "real_name": "Egon Spengler", - "real_name_normalized": "Egon Spengler", - "status_emoji": ":books:", - "status_text": "Print is dead", - "team": "T012AB3C4" - }, - "real_name": "Egon Spengler", - "team_id": "T012AB3C4", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "updated": 1502138686 - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.info method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "user": { - "$ref": "#/definitions/objs_user" - } - }, - "required": [ - "ok", - "user" - ], - "title": "users.info success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "user_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.info method", - "properties": { - "callstack": { - "type": "string" - }, - "error": { - "enum": [ - "user_not_found", - "user_not_visible", - "not_authed", - "invalid_auth", - "account_inactive", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.info error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:read" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.list": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Lists all users in a Slack team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.list" - }, - "operationId": "users_list", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:read`", - "in": "query", - "name": "token", - "type": "string" - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.", - "in": "query", - "name": "limit", - "type": "integer" - }, - { - "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "type": "string" - }, - { - "description": "Set this to `true` to receive the locale for users. Defaults to `false`", - "in": "query", - "name": "include_locale", - "type": "boolean" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "cache_ts": 1498777272, - "members": [ - { - "color": "9f69e7", - "deleted": false, - "has_2fa": false, - "id": "W012A3CDE", - "is_admin": true, - "is_app_user": false, - "is_bot": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "name": "spengler", - "profile": { - "avatar_hash": "ge3b51ca72de", - "display_name": "spengler", - "display_name_normalized": "spengler", - "email": "spengler@ghostbusters.example.com", - "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "real_name": "Egon Spengler", - "real_name_normalized": "Egon Spengler", - "status_emoji": ":books:", - "status_text": "Print is dead", - "team": "T012AB3C4" - }, - "real_name": "spengler", - "team_id": "T012AB3C4", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "updated": 1502138686 - }, - { - "color": "9f69e7", - "deleted": false, - "has_2fa": false, - "id": "W07QCRPA4", - "is_admin": true, - "is_bot": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "name": "glinda", - "profile": { - "avatar_hash": "8fbdd10b41c6", - "display_name": "Glinda the Fairly Good", - "display_name_normalized": "Glinda the Fairly Good", - "email": "glenda@south.oz.coven", - "first_name": "Glinda", - "image_1024": "https://a.slack-edge.com...png", - "image_192": "https://a.slack-edge.com...png", - "image_24": "https://a.slack-edge.com...png", - "image_32": "https://a.slack-edge.com...png", - "image_48": "https://a.slack-edge.com...png", - "image_512": "https://a.slack-edge.com...png", - "image_72": "https://a.slack-edge.com...png", - "image_original": "https://a.slack-edge.com...png", - "last_name": "Southgood", - "phone": "", - "real_name": "Glinda Southgood", - "real_name_normalized": "Glinda Southgood", - "skype": "", - "title": "Glinda the Good" - }, - "real_name": "Glinda Southgood", - "team_id": "T0G9PQBBK", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "updated": 1480527098 - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "dXNlcjpVMEc5V0ZYTlo=" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.list method", - "properties": { - "cache_ts": { - "type": "integer" - }, - "members": { - "items": { - "$ref": "#/definitions/objs_user" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "response_metadata": { - "$ref": "#/definitions/objs_response_metadata" - } - }, - "required": [ - "ok", - "members", - "cache_ts" - ], - "title": "users.list schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_cursor", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.list method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "limit_required", - "invalid_cursor", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.list error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:read" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.lookupByEmail": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Find a user with an email address.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.lookupByEmail" - }, - "operationId": "users_lookupByEmail", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:read.email`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "An email address belonging to a user in the workspace", - "in": "query", - "name": "email", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "user": { - "color": "9f69e7", - "deleted": false, - "has_2fa": false, - "id": "W012A3CDE", - "is_admin": true, - "is_app_user": false, - "is_bot": false, - "is_owner": false, - "is_primary_owner": false, - "is_restricted": false, - "is_ultra_restricted": false, - "name": "spengler", - "profile": { - "avatar_hash": "ge3b51ca72de", - "display_name": "spengler", - "display_name_normalized": "spengler", - "email": "spengler@ghostbusters.example.com", - "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "real_name": "Egon Spengler", - "real_name_normalized": "Egon Spengler", - "status_emoji": ":books:", - "status_text": "Print is dead", - "team": "T012AB3C4" - }, - "real_name": "Egon Spengler", - "team_id": "T012AB3C4", - "tz": "America/Los_Angeles", - "tz_label": "Pacific Daylight Time", - "tz_offset": -25200, - "updated": 1502138686 - } - } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.lookupByEmail method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "user": { - "$ref": "#/definitions/objs_user" - } - }, - "required": [ - "ok", - "user" - ], - "title": "users.lookupByEmail success schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "users_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.lookupByEmail method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "users_not_found", - "enterprise_is_restricted", - "not_authed", - "invalid_auth", - "account_inactive", - "no_permission", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.lookupByEmail error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:read.email" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.profile.get": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Retrieves a user's profile information.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.profile.get" - }, - "operationId": "users_profile_get", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users.profile:read`", - "in": "query", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Include labels for each ID in custom profile fields", - "in": "query", - "name": "include_labels", - "type": "boolean" - }, - { - "description": "User to retrieve profile info for", - "in": "query", - "name": "user", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "profile": { - "avatar_hash": "ge3b51ca72de", - "display_name": "spengler", - "display_name_normalized": "spengler", - "email": "spengler@ghostbusters.example.com", - "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_original": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "real_name": "Egon Spengler", - "real_name_normalized": "Egon Spengler", - "status_emoji": ":books:", - "status_expiration": 0, - "status_text": "Print is dead", - "team": "T012AB3C4" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.profile.get method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "profile": { - "$ref": "#/definitions/objs_user_profile" - } - }, - "required": [ - "ok", - "profile" - ], - "title": "users.profile.get schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "user_not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.profile.get method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "user_not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.profile.get error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users.profile:read" - ] - } - ], - "tags": [ - "users.profile", - "users" - ] - } - }, - "/users.profile.set": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Set the profile information for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.profile.set" - }, - "operationId": "users_profile_set", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users.profile:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Name of a single key to set. Usable only if `profile` is not passed.", - "in": "formData", - "name": "name", - "type": "string" - }, - { - "description": "Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.", - "in": "formData", - "name": "profile", - "type": "string" - }, - { - "description": "ID of user to change. This argument may only be specified by team admins on paid teams.", - "in": "formData", - "name": "user", - "type": "string" - }, - { - "description": "Value to set a single key to. Usable only if `profile` is not passed.", - "in": "formData", - "name": "value", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true, - "profile": { - "avatar_hash": "ge3b51ca72de", - "display_name": "spengler", - "display_name_normalized": "spengler", - "email": "spengler@ghostbusters.example.com", - "image_192": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_24": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_32": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_48": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_512": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "image_72": "https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg", - "real_name": "Egon Spengler", - "real_name_normalized": "Egon Spengler", - "status_emoji": ":books:", - "status_expiration": 0, - "status_text": "Print is dead", - "team": "T012AB3C4" - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.profile.set method", - "properties": { - "email_pending": { - "format": "email", - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "profile": { - "$ref": "#/definitions/objs_user_profile" - }, - "username": { - "type": "string" - } - }, - "required": [ - "ok", - "username", - "profile" - ], - "title": "users.profile.set schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_profile", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.profile.set method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "reserved_name", - "invalid_profile", - "profile_set_failed", - "not_admin", - "not_app_admin", - "cannot_update_admin_user", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.profile.set error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users.profile:write" - ] - } - ], - "tags": [ - "users.profile", - "users" - ] - } - }, - "/users.setActive": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Marked a user as active. Deprecated and non-functional.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setActive" - }, - "operationId": "users_setActive", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.setActive method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "users.setActive schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.setActive method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "ekm_access_denied", - "missing_scope", - "invalid_arguments", - "invalid_arg_name", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "request_timeout", - "fatal_error", - "internal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.setActive error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:write" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.setPhoto": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded" - ], - "description": "Set the user profile photo", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setPhoto" - }, - "operationId": "users_setPhoto", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users.profile:write`", - "in": "formData", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Width/height of crop box (always square)", - "in": "formData", - "name": "crop_w", - "type": "string" - }, - { - "description": "X coordinate of top-left corner of crop box", - "in": "formData", - "name": "crop_x", - "type": "string" - }, - { - "description": "Y coordinate of top-left corner of crop box", - "in": "formData", - "name": "crop_y", - "type": "string" - }, - { - "description": "File contents via `multipart/form-data`.", - "in": "formData", - "name": "image", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.setPhoto method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - }, - "profile": { - "additionalProperties": false, - "properties": { - "avatar_hash": { - "pattern": "^[0-9a-f]{12}$", - "type": "string" - }, - "image_1024": { - "format": "uri", - "type": "string" - }, - "image_192": { - "format": "uri", - "type": "string" - }, - "image_24": { - "format": "uri", - "type": "string" - }, - "image_32": { - "format": "uri", - "type": "string" - }, - "image_48": { - "format": "uri", - "type": "string" - }, - "image_512": { - "format": "uri", - "type": "string" - }, - "image_72": { - "format": "uri", - "type": "string" - }, - "image_original": { - "format": "uri", - "type": "string" - } - }, - "required": [ - "image_24", - "image_32", - "image_48", - "image_72", - "image_192", - "image_512", - "image_1024", - "image_original", - "avatar_hash" - ], - "type": "object" - } - }, - "required": [ - "ok", - "profile" - ], - "title": "users.setPhoto schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.setPhoto method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "debug_step": { - "description": "possibly DEV/QA only", - "type": "string" - }, - "dims": { - "description": "possibly DEV/QA only", - "type": "string" - }, - "error": { - "enum": [ - "bad_image", - "too_large", - "too_many_frames", - "not_found", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "user_is_bot", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - }, - "time_ident": { - "description": "possibly DEV/QA only", - "type": "integer" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.setPhoto error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users.profile:write" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/users.setPresence": { - "post": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Manually sets user presence.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setPresence" - }, - "operationId": "users_setPresence", - "parameters": [ - { - "description": "Authentication token. Requires scope: `users:write`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Either `auto` or `away`", - "in": "formData", - "name": "presence", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.setPresence method", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "users.setPresence schema", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for error response from users.setPresence method", - "properties": { - "callstack": { - "description": "Note: PHP callstack is only visible in dev/qa", - "type": "string" - }, - "error": { - "enum": [ - "invalid_presence", - "not_authed", - "invalid_auth", - "account_inactive", - "token_revoked", - "no_permission", - "org_login_required", - "invalid_arg_name", - "invalid_array_arg", - "invalid_charset", - "invalid_form_data", - "invalid_post_type", - "missing_post_type", - "team_added_to_org", - "invalid_json", - "json_not_object", - "request_timeout", - "upgrade_required", - "fatal_error" - ], - "type": "string" - }, - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok", - "error" - ], - "title": "users.setPresence error schema", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "users:write" - ] - } - ], - "tags": [ - "users" - ] - } - }, - "/views.open": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Open a view for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/views.open" - }, - "operationId": "views_open", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Exchange a trigger to post to the user.", - "in": "query", - "name": "trigger_id", - "required": true, - "type": "string" - }, - { - "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", - "in": "query", - "name": "view", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response includes the opened view payload.", - "examples": { - "application/json": { - "ok": true, - "view": { - "app_id": "AA4928AQ", - "blocks": [ - { - "block_id": "a_block_id", - "element": { - "action_id": "an_action_id", - "type": "plain_text_input" - }, - "label": { - "emoji": true, - "text": "A simple label", - "type": "plain_text" - }, - "optional": false, - "type": "input" - } - ], - "bot_id": "BA13894H", - "callback_id": "identify_your_modals", - "clear_on_close": false, - "external_id": "", - "hash": "156772938.1827394", - "id": "VMHU10V25", - "notify_on_close": false, - "private_metadata": "Shh it is a secret", - "root_view_id": "VMHU10V25", - "state": { - "values": {} - }, - "submit": { - "text": "Create", - "type": "plain_text" - }, - "team_id": "T8N4K1JN", - "title": { - "text": "Quite a plain modal", - "type": "plain_text" - }, - "type": "modal" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response, before getting to any possible validation errors.", - "examples": { - "application/json": { - "error": "invalid_arguments", - "ok": false, - "response_metadata": { - "messages": [ - "invalid `trigger_id`" - ] - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "views" - ] - } - }, - "/views.publish": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Publish a static view for a User.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/views.publish" - }, - "operationId": "views_publish", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "`id` of the user you want publish a view to.", - "in": "query", - "name": "user_id", - "required": true, - "type": "string" - }, - { - "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", - "in": "query", - "name": "view", - "required": true, - "type": "string" - }, - { - "description": "A string that represents view state to protect against possible race conditions.", - "in": "query", - "name": "hash", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response includes the published view payload.", - "examples": { - "application/json": { - "ok": true, - "view": { - "app_id": "AA4928AQ", - "blocks": [ - { - "block_id": "2WGp9", - "text": { - "text": "A simple section with some sample sentence.", - "type": "mrkdwn", - "verbatim": false - }, - "type": "section" - } - ], - "bot_id": "BA13894H", - "callback_id": "identify_your_home_tab", - "clear_on_close": false, - "close": null, - "external_id": "", - "hash": "156772938.1827394", - "id": "VMHU10V25", - "notify_on_close": false, - "previous_view_id": null, - "private_metadata": "Shh it is a secret", - "root_view_id": "VMHU10V25", - "state": { - "values": {} - }, - "submit": null, - "team_id": "T8N4K1JN", - "type": "home" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response, before getting to any possible validation errors.", - "examples": { - "application/json": { - "error": "invalid_arguments", - "ok": false, - "response_metadata": { - "messages": [ - "invalid `user_id`" - ] - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "views" - ] - } - }, - "/views.push": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Push a view onto the stack of a root view.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/views.push" - }, - "operationId": "views_push", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Exchange a trigger to post to the user.", - "in": "query", - "name": "trigger_id", - "required": true, - "type": "string" - }, - { - "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", - "in": "query", - "name": "view", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response includes the pushed view payload.", - "examples": { - "application/json": { - "ok": true, - "view": { - "app_id": "AAD3351BQ", - "blocks": [ - { - "block_id": "edit_details", - "element": { - "action_id": "detail_input", - "type": "plain_text_input" - }, - "label": { - "text": "Edit details", - "type": "plain_text" - }, - "type": "input" - } - ], - "bot_id": "BADF7A34H", - "callback_id": "view_4", - "clear_on_close": true, - "close": { - "emoji": true, - "text": "Back", - "type": "plain_text" - }, - "external_id": "", - "hash": "1569362015.55b5e41b", - "id": "VNM522E2U", - "notify_on_close": false, - "previous_view_id": null, - "private_metadata": "", - "root_view_id": "VNN729E3U", - "state": { - "values": {} - }, - "submit": { - "emoji": true, - "text": "Save", - "type": "plain_text" - }, - "team_id": "T9M4RL1JM", - "title": { - "emoji": true, - "text": "Pushed Modal", - "type": "plain_text" - }, - "type": "modal" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response.", - "examples": { - "application/json": { - "error": "invalid_arguments", - "ok": false, - "response_metadata": { - "messages": [ - "missing required field: title" - ] - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "views" - ] - } - }, - "/views.update": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Update an existing view.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/views.update" - }, - "operationId": "views_update", - "parameters": [ - { - "description": "Authentication token. Requires scope: `none`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", - "in": "query", - "name": "view_id", - "type": "string" - }, - { - "description": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", - "in": "query", - "name": "external_id", - "type": "string" - }, - { - "description": "A [view object](/reference/surfaces/views). This must be a JSON-encoded string.", - "in": "query", - "name": "view", - "type": "string" - }, - { - "description": "A string that represents view state to protect against possible race conditions.", - "in": "query", - "name": "hash", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response includes the updated view payload.", - "examples": { - "application/json": { - "ok": true, - "view": { - "app_id": "AAD3351BQ", - "blocks": [ - { - "accessory": { - "action_id": "button_4", - "text": { - "text": "Click me", - "type": "plain_text" - }, - "type": "button" - }, - "block_id": "s_block", - "text": { - "emoji": true, - "text": "I am but an updated modal", - "type": "plain_text" - }, - "type": "section" - } - ], - "bot_id": "BADF7A34H", - "callback_id": "view_2", - "clear_on_close": true, - "close": { - "emoji": true, - "text": "Close", - "type": "plain_text" - }, - "external_id": "", - "hash": "1569262015.55b5e41b", - "id": "VNM522E2U", - "notify_on_close": false, - "previous_view_id": null, - "private_metadata": "", - "root_view_id": "VNN729E3U", - "state": { - "values": {} - }, - "submit": null, - "team_id": "T9M4RL1JM", - "title": { - "emoji": true, - "text": "Updated Modal", - "type": "plain_text" - }, - "type": "modal" - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response.", - "examples": { - "application/json": { - "error": "not_found", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "none" - ] - } - ], - "tags": [ - "views" - ] - } - }, - "/workflows.stepCompleted": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Indicate that an app's step in a workflow completed execution.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/workflows.stepCompleted" - }, - "operationId": "workflows_stepCompleted", - "parameters": [ - { - "description": "Authentication token. Requires scope: `workflow.steps:execute`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Context identifier that maps to the correct workflow step execution.", - "in": "query", - "name": "workflow_step_execute_id", - "required": true, - "type": "string" - }, - { - "description": "Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.", - "in": "query", - "name": "outputs", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "workflow.steps:execute" - ] - } - ], - "tags": [ - "workflows" - ] - } - }, - "/workflows.stepFailed": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Indicate that an app's step in a workflow failed to execute.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/workflows.stepFailed" - }, - "operationId": "workflows_stepFailed", - "parameters": [ - { - "description": "Authentication token. Requires scope: `workflow.steps:execute`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "Context identifier that maps to the correct workflow step execution.", - "in": "query", - "name": "workflow_step_execute_id", - "required": true, - "type": "string" - }, - { - "description": "A JSON-based object with a `message` property that should contain a human readable error message.", - "in": "query", - "name": "error", - "required": true, - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "workflow.steps:execute" - ] - } - ], - "tags": [ - "workflows" - ] - } - }, - "/workflows.updateStep": { - "get": { - "consumes": [ - "application/x-www-form-urlencoded", - "application/json" - ], - "description": "Update the configuration for a workflow extension step.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/workflows.updateStep" - }, - "operationId": "workflows_updateStep", - "parameters": [ - { - "description": "Authentication token. Requires scope: `workflow.steps:execute`", - "in": "header", - "name": "token", - "required": true, - "type": "string" - }, - { - "description": "A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.", - "in": "query", - "name": "workflow_step_edit_id", - "required": true, - "type": "string" - }, - { - "description": "A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).", - "in": "query", - "name": "inputs", - "type": "string" - }, - { - "description": "An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.", - "in": "query", - "name": "outputs", - "type": "string" - }, - { - "description": "An optional field that can be used to override the step name that is shown in the Workflow Builder.", - "in": "query", - "name": "step_name", - "type": "string" - }, - { - "description": "An optional field that can be used to override app image that is shown in the Workflow Builder.", - "in": "query", - "name": "step_image_url", - "type": "string" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Typical success response", - "examples": { - "application/json": { - "ok": true - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "Default success template", - "type": "object" - } - }, - "default": { - "description": "Typical error response", - "examples": { - "application/json": { - "error": "invalid_auth", - "ok": false - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/definitions/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "Default error template", - "type": "object" - } - } - }, - "security": [ - { - "slackAuth": [ - "workflow.steps:execute" - ] - } - ], - "tags": [ - "workflows" - ] - } - } - }, - "schemes": [ - "https" - ], - "securityDefinitions": { - "slackAuth": { - "authorizationUrl": "https://slack.com/oauth/authorize", - "flow": "accessCode", - "scopes": { - "admin": "admin", - "admin.apps:read": "admin.apps:read", - "admin.apps:write": "admin.apps:write", - "admin.conversations:read": "admin.conversations:read", - "admin.conversations:write": "admin.conversations:write", - "admin.invites:read": "admin.invites:read", - "admin.invites:write": "admin.invites:write", - "admin.teams:read": "admin.teams:read", - "admin.teams:write": "admin.teams:write", - "admin.usergroups:read": "admin.usergroups:read", - "admin.usergroups:write": "admin.usergroups:write", - "admin.users:read": "admin.users:read", - "admin.users:write": "admin.users:write", - "authorizations:read": "authorizations:read", - "bot": "Bot user scope", - "calls:read": "calls:read", - "calls:write": "calls:write", - "channels:history": "channels:history", - "channels:manage": "channels:manage", - "channels:read": "channels:read", - "channels:write": "channels:write", - "chat:write": "chat:write", - "chat:write:bot": "Author messages as a bot", - "chat:write:user": "Author messages as a user", - "conversations:history": "conversations:history", - "conversations:read": "conversations:read", - "conversations:write": "conversations:write", - "dnd:read": "dnd:read", - "dnd:write": "dnd:write", - "emoji:read": "emoji:read", - "files:read": "files:read", - "files:write:user": "files:write:user", - "groups:history": "groups:history", - "groups:read": "groups:read", - "groups:write": "groups:write", - "identity.basic": "identity.basic", - "im:history": "im:history", - "im:read": "im:read", - "im:write": "im:write", - "links:write": "links:write", - "mpim:history": "mpim:history", - "mpim:read": "mpim:read", - "mpim:write": "mpim:write", - "none": "No scope required", - "pins:read": "pins:read", - "pins:write": "pins:write", - "reactions:read": "reactions:read", - "reactions:write": "reactions:write", - "reminders:read": "reminders:read", - "reminders:write": "reminders:write", - "remote_files:read": "remote_files:read", - "remote_files:share": "remote_files:share", - "remote_files:write": "remote_files:write", - "rtm:stream": "rtm:stream", - "search:read": "search:read", - "stars:read": "stars:read", - "stars:write": "stars:write", - "team:read": "team:read", - "tokens.basic": "tokens.basic", - "usergroups:read": "usergroups:read", - "usergroups:write": "usergroups:write", - "users.profile:read": "users.profile:read", - "users.profile:write": "users.profile:write", - "users:read": "users:read", - "users:read.email": "users:read.email", - "users:write": "users:write", - "workflow.steps:execute": "workflow.steps:execute" - }, - "tokenUrl": "https://slack.com/api/oauth.access", - "type": "oauth2" - } - }, - "swagger": "2.0", - "tags": [] -} \ No newline at end of file diff --git a/test/blackbox/utils/Utils.ts b/test/blackbox/utils/Utils.ts deleted file mode 100644 index 5a77f2d7cf..0000000000 --- a/test/blackbox/utils/Utils.ts +++ /dev/null @@ -1,99 +0,0 @@ -/* eslint-disable no-undef */ -/* eslint-disable security/detect-non-literal-fs-filename */ -import { promises as fs } from 'fs'; -import * as path from 'path'; -import { AbstractGenerator, FormatHelpers, OutputModel } from '../../../src'; -import { promisify } from 'util'; -import { exec } from 'child_process'; -const promiseExec = promisify(exec); - -/** - * Exec a command and if any errors occur reject the promise. - * - * @param absolutePathToFile - * @param generator - */ -export async function generateModels( - absolutePathToFile: string, - generator: AbstractGenerator -): Promise { - const inputFileContent = await fs.readFile(absolutePathToFile); - const input = JSON.parse(String(inputFileContent)); - return generator.generate(input); -} -/** - * Execute a command and if any errors occur reject the promise. - * - * @param command - */ -export async function execCommand( - command: string, - allowStdError = false -): Promise { - try { - const { stderr } = await promiseExec(command); - if (stderr !== '') { - if (!allowStdError) { - return Promise.reject(stderr); - } - // eslint-disable-next-line no-console - console.error(stderr); - } - return Promise.resolve(); - } catch (e: any) { - return Promise.reject(`${e.stack}; Stdout: ${e.stdout}`); - } -} - -/** - * Render all models to separate files in the same directory - * - * @param generatedModels to write to file - * @param outputPath absolute path to output directory - */ -export async function renderModelsToSeparateFiles( - generatedModels: OutputModel[], - outputPath: string, - extension: string -): Promise { - await fs.rm(outputPath, { recursive: true, force: true }); - await fs.mkdir(outputPath, { recursive: true }); - for (const outputModel of generatedModels) { - const outputFilePath = path.resolve( - outputPath, - `${FormatHelpers.toPascalCase( - outputModel.model.name || 'undefined' - )}.${extension}` - ); - const outputContent = ` -${outputModel.dependencies.join('\n')} -${outputModel.result} -`; - await fs.writeFile(outputFilePath, outputContent); - } -} - -/** - * Render all models to a single file - * - * @param models to write to file - * @param outputPath path to output - */ -export async function renderModels( - generatedModels: OutputModel[], - outputPath: string, - headers?: string[] -): Promise { - const outputDir = path.resolve(__dirname, path.dirname(outputPath)); - await fs.rm(outputDir, { recursive: true, force: true }); - await fs.mkdir(outputDir, { recursive: true }); - const output = generatedModels.map((model) => { - return model.result; - }); - - const stringOutput = headers - ? `${headers.join('\n')}\n\n${output.join('\n')}` - : output.join('\n'); - const outputFilePath = path.resolve(__dirname, outputPath); - await fs.writeFile(outputFilePath, stringOutput); -} diff --git a/test/runtime/runtime-cplusplus.spec.ts b/test/runtime/runtime-cplusplus.spec.ts index 94fc413993..d92f6d91b3 100644 --- a/test/runtime/runtime-cplusplus.spec.ts +++ b/test/runtime/runtime-cplusplus.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-csharp.spec.ts b/test/runtime/runtime-csharp.spec.ts index fdd8279c2e..eca028e67f 100644 --- a/test/runtime/runtime-csharp.spec.ts +++ b/test/runtime/runtime-csharp.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-go.spec.ts b/test/runtime/runtime-go.spec.ts index 1110d0be1f..bf682844ea 100644 --- a/test/runtime/runtime-go.spec.ts +++ b/test/runtime/runtime-go.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from "../blackbox/utils/Utils"; +import { execCommand } from "../TestUtils/GeneralUtils"; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-java.spec.ts b/test/runtime/runtime-java.spec.ts index d814fbd892..49b7d60629 100644 --- a/test/runtime/runtime-java.spec.ts +++ b/test/runtime/runtime-java.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-kotlin.spec.ts b/test/runtime/runtime-kotlin.spec.ts index 927c03e014..3788f74663 100644 --- a/test/runtime/runtime-kotlin.spec.ts +++ b/test/runtime/runtime-kotlin.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-php.spec.ts b/test/runtime/runtime-php.spec.ts index 514416038f..337a4b58fa 100644 --- a/test/runtime/runtime-php.spec.ts +++ b/test/runtime/runtime-php.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000); diff --git a/test/runtime/runtime-python.spec.ts b/test/runtime/runtime-python.spec.ts index abb50019b2..a290ab32de 100644 --- a/test/runtime/runtime-python.spec.ts +++ b/test/runtime/runtime-python.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from "../blackbox/utils/Utils"; +import { execCommand } from "../TestUtils/GeneralUtils"; import path from "path"; diff --git a/test/runtime/runtime-rust.spec.ts b/test/runtime/runtime-rust.spec.ts index bc260ae383..20951992e0 100644 --- a/test/runtime/runtime-rust.spec.ts +++ b/test/runtime/runtime-rust.spec.ts @@ -1,5 +1,5 @@ import path from 'path'; -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; jest.setTimeout(500000); diff --git a/test/runtime/runtime-scala.spec.ts b/test/runtime/runtime-scala.spec.ts index d2a782d377..5e9f666904 100644 --- a/test/runtime/runtime-scala.spec.ts +++ b/test/runtime/runtime-scala.spec.ts @@ -1,4 +1,4 @@ -import { execCommand } from '../blackbox/utils/Utils'; +import { execCommand } from '../TestUtils/GeneralUtils'; import path from 'path'; jest.setTimeout(50000);